Skip to content

Commit

Permalink
chore: move README back to a rst file 😶
Browse files Browse the repository at this point in the history
  • Loading branch information
moritzlerch committed Jul 30, 2023
1 parent 75b8a72 commit 4522863
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 59 deletions.
59 changes: 0 additions & 59 deletions README.md

This file was deleted.

68 changes: 68 additions & 0 deletions README.rst
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

0 comments on commit 4522863

Please sign in to comment.