49 lines
1.3 KiB
ReStructuredText
49 lines
1.3 KiB
ReStructuredText
|
pretalx musicrate plugin
|
||
|
|
==========================
|
||
|
|
|
||
|
|
This is a plugin for `pretalx`_.
|
||
|
|
pretalx plugin for rating music
|
||
|
|
|
||
|
|
Development setup
|
||
|
|
-----------------
|
||
|
|
|
||
|
|
1. Make sure that you have a working `pretalx development setup`_.
|
||
|
|
|
||
|
|
2. Clone this repository, eg to ``local/pretalx-musicrate``.
|
||
|
|
|
||
|
|
3. Activate the virtual environment you use for pretalx development.
|
||
|
|
|
||
|
|
4. Run ``pip install -e .`` within this directory to register this application with pretalx's plugin registry.
|
||
|
|
|
||
|
|
5. Run ``make`` within this directory to compile translations.
|
||
|
|
|
||
|
|
6. Restart your local pretalx server. This plugin should show up in the plugin list shown on startup in the console.
|
||
|
|
You can now use the plugin from this repository for your events by enabling it in the 'plugins' tab in the settings.
|
||
|
|
|
||
|
|
This plugin has CI set up to enforce a few code style rules. To check locally, you need these packages installed::
|
||
|
|
|
||
|
|
pip install flake8 flake8-bugbear isort black
|
||
|
|
|
||
|
|
To check your plugin for rule violations, run::
|
||
|
|
|
||
|
|
black --check .
|
||
|
|
isort -c .
|
||
|
|
flake8 .
|
||
|
|
|
||
|
|
You can auto-fix some of these issues by running::
|
||
|
|
|
||
|
|
isort .
|
||
|
|
black .
|
||
|
|
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
|
||
|
|
Copyright 2023 Luca
|
||
|
|
|
||
|
|
Released under the terms of the Apache License 2.0
|
||
|
|
|
||
|
|
|
||
|
|
.. _pretalx: https://github.com/pretalx/pretalx
|
||
|
|
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
|