README.md

Caution

This repository is no longer maintained. It is published as part of the synyx history and it provides a full picture together with its corresponding blog posts:

• https://synyx.de/blog/die-geschichte-vom-rabenyx-teil-1-organisation/
• https://synyx.de/blog/die-geschichte-vom-rabenyx-teil-2-entwicklung/
• https://synyx.de/blog/die-geschichte-vom-rabenyx-teil-3-open-source/

Rabenyx

An ally for the fight against the chaos of Corona organisation at synyx. It is intended to use the Polls app for Nextcloud and uses its rudimentary API.

If you seek information for the web application see its documentation for details.

How to configure

INI file

Create a file ~/.config/rabenyx.ini and use the following syntax:

[DEFAULT]
username=
password=
url=https://nextcloud.example.com

Environment variables

If you cannot or do not want to use an ini file, you can use environment variables instead:

NEXTCLOUD_USERNAME=
NEXTCLOUD_PASSWORD=
NEXTCLOUD_URL=https://nextcloud.example.com

You need to add a new app password to use this feature, see the security section of your Nextcloud account to add one.

How to use

Use python3 rabenyx.py --help to see all of its features.

How to develop

Run initially

pip install -e . -r requirements.txt

to setup your environment for testing. Run

pytest

to run the tests.

API, DB or web?

There are three ways to talk to the Poll app:

• via its API
• via the web way
• via the database

If you develop for Rabenyx, try the API way first. It is partly documented. Sometimes it helps to look at its routes too. If the API does not satisfy your needs try the web way. If this doesn't help at all you can consider using the database at last.

Document the used API bits in OAS3.