|byro|

September 24, 2023 ยท View on GitHub

.. image:: https://img.shields.io/github/v/release/byro/byro :target: https://github.com/byro/byro/releases/latest :alt: GitHub release (with filter)

.. image:: https://img.shields.io/pypi/v/byro :target: https://pypi.org/project/byro/ :alt: PyPI - Version

.. image:: https://github.com/byro/byro/actions/workflows/ci-cd.yml/badge.svg?branch=main :target: https://github.com/byro/byro/actions/workflows/ci-cd.yml?query=branch%3Amain :alt: CI/CD

.. image:: https://codecov.io/gh/byro/byro/branch/main/graph/badge.svg :target: https://codecov.io/gh/byro/byro :alt: Code coverage

.. image:: https://img.shields.io/codeclimate/maintainability/byro/byro.svg :target: https://codeclimate.com/github/byro/byro :alt: Code maintainability

.. image:: https://readthedocs.org/projects/byro/badge/?version=latest :target: http://byro.readthedocs.io/ :alt: Documentation

byro_ is a membership administration tool for small and medium sized clubs/NGOs/associations of all kinds, with a focus on the DACH region. While it is still a work in progress, it is already usable and in active use.

.. image:: https://raw.githubusercontent.com/byro/byro/main/docs/img/screenshots/office_dashboard.png

Development and Production Setup

Please refer to the development_ or the production documentation_.

Features

Planned features

Official Plugins

byro provides a rich API for plugins. See our developer documentation_ if you want to write a plugin. If you want your plugin to be officially recognized or listed here, please open an issue or a pull request.

  • byro-mailman_ provides integration with the mailman mailing list tool, including automatic subscriptions, member lists, and removals.
  • byro-gemeinnuetzigkeit_ provides tools for German non-profits, most notably receipts for membership fees and donations.

Inofficial Plugins

Inofficial plugins are encouraged to add the byro-plugin tag if they are on GitHub. You can see all byro plugins on GitHub here_.

  • 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.

.. |byro| image:: https://raw.githubusercontent.com/byro/byro/main/docs/img/logo/byro_128.png :alt: byro .. _developer documentation: http://byro.readthedocs.io/en/latest/ .. _development: https://byro.readthedocs.io/en/latest/developer/setup.html .. _byro: https://byro.cloud .. _here: https://github.com/topics/byro-plugin .. _byro-mailman: https://github.com/byro/byro-mailman .. _byro-gemeinnuetzigkeit: https://github.com/byro/byro-gemeinnuetzigkeit .. _byro-shackspace: https://github.com/byro/byro-shackspace .. _production documentation: https://byro.readthedocs.io/en/latest/administrator/