You may extend the bf tool by writing a plugin.

A bf plugin must take one of two forms:

Regardless of the form of plugin you choose, your plugin project’s must define an entry point in the botoform.plugins group. The name of the entry point will be the subcommand on the CLI.

All bf subcommands (core plugins) are implemented in this way.

See also

working examples plugins directory.


entry point

entry point:

An entry point is a Python object identified in a project’s file. The object is referenced by group and name to make it discoverable.

This means that another Python application can search for installed software. During the search, often the entry point group filters relevant objects.

Botoform uses this method to allow plugins to load at run time.