-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: move README back to a rst file 😶
- Loading branch information
1 parent
75b8a72
commit 4522863
Showing
2 changed files
with
68 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
Manual Seats | ||
============ | ||
|
||
This is a plugin for `pretix`_. | ||
|
||
Manually assign tickets to seats. | ||
|
||
Development setup | ||
----------------- | ||
|
||
1. Make sure that you have a working `pretix development setup`_. | ||
2. Clone this repository. | ||
3. Activate the virtual environment you use for pretix development. | ||
4. Execute ``python setup.py develop`` within this directory to register | ||
this application with pretix's plugin registry. | ||
5. Execute ``make`` within this directory to compile translations. | ||
6. Restart your local pretix server. 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: | ||
|
||
.. code:: bash | ||
pip install flake8 isort black | ||
To check your plugin for rule violations, run: | ||
|
||
.. code:: bash | ||
black --check . | ||
isort -c . | ||
flake8 . | ||
You can auto-fix some of these issues by running: | ||
|
||
.. code:: bash | ||
isort . | ||
black . | ||
To automatically check for these issues before you commit, you can run | ||
``.install-hooks``. | ||
|
||
License | ||
------- | ||
|
||
Copyright 2023 Moritz Lerch, Mark Oude Elberink | ||
|
||
Released under the terms of the Apache License 2.0 | ||
|
||
Internal Usage with Docker | ||
-------------------------- | ||
|
||
.. code:: dockerfile | ||
FROM ghcr.io/moritzlerch/pretix-manualseats as pretix_manualseats | ||
FROM pretix... | ||
... | ||
COPY --from=pretix_manualseats /plugins/pretix_manualseats /plugins/pretix_manualseats | ||
RUN pip install -e /plugins/pretix_manualseats | ||
.. _pretix: https://github.com/pretix/pretix | ||
.. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html |