byro 2026.3.1

Development and Production Setup

Please refer to the development or the production documentation. The recommended way to run byro is byroctl, which installs and updates a Docker based deployment with one command; Docker Compose by hand and a plain installation from PyPI are documented as well.

Features

Planned features

Plugins

byro provides a rich API for plugins. See our developer documentation if you want to write a plugin.

Plugins that work with the current byro release are listed in the plugin catalog that ships with every release; administrators install them with byroctl plugin add <name> (see the plugin documentation). To get a plugin listed, publish a GitHub release and open a pull request against the catalog.

• byro-finance-import-bank-files imports file-based bank statements, currently CAMT.053.

• byro-mailman (mailing list integration) and byro-gemeinnuetzigkeit (receipts for German non-profits) exist, but are not yet compatible with byro 2026.x.

Community plugins are encouraged to add the byro-plugin tag if they are on GitHub. You can see all byro plugins on GitHub here; byroctl never installs anything from that list on its own. byro-shackspace is an example for how a group can extend or modify byro to fit their purpose, e.g. add custom mechanisms and save additional data.

License

byro is licensed under the GNU Affero General Public License, version 3.0 only (AGPL-3.0-only). Older versions of byro were released under the Apache License 2.0. The documentation in docs/ is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA-4.0). See the LICENSE file for details, including the licensing history and the licenses of bundled third-party components.