Configure Balder

Important

Please note that this part of the documentation is not yet finished. It will still be revised and updated.

Console arguments

Balder provides a lot of different console arguments. You can get an overview by calling:

$ balder --help

BalderSettings object

You can specify different settings in a BalderSetting class in your balderglob.py file. For this you have to create a new class inside the balderglob.py file, that inherits from BalderSetting.

# file `balderglob.py`
import balder
...

class MySettings(balder.BalderSetting):
    ...
    used_global_connection_tree = "my-own-tree"
    ...

BalderPlugin object

You can also influence the mechanism of Balder by developing Balder plugins. For this Balder has a global plugin object that allows to interact with different callbacks. This helps you to influence the mechanism of the Balder system.

Note

The plugin section is still under development. We will integrate and add new callbacks soon!

If you want to create and use a Balder plugin, simply create a new child object of BalderPlugin and include it in the global balderglob.py file:

# file `balderglob.py`
import balder
...

class MyPlugin(balder.BalderPlugin):

    ...

    def modify_collected_pyfiles(self, pyfiles):
        ..
        return filtered_pyfiles

    ...

If you only want to use a third-party-plugin, you only have to install it and import the plugin class into your balderglob.py file.

# file `balderglob.py`
import balder
...
from my.third.party.plugin import MyPluginClass

The following shows the documentation of the BalderPlugin object:

balder.BalderPlugin(session: BalderSession)

This is the balder plugin class. You can create your own plugin, by creating a subclass of it. With that you are able to overwrite the methods you want to use in your plugin.