From b8bd8308027d49fedd50e8350ebf84331ee133b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Felix=20Sch=C3=A4fer?= <felix@thegcat.net>
Date: Thu, 9 Feb 2023 23:17:24 +0100
Subject: [PATCH] Move README to markdown
---
README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
README.rst | 53 -----------------------------------------------------
setup.py | 3 ++-
3 files changed, 45 insertions(+), 54 deletions(-)
create mode 100644 README.md
delete mode 100644 README.rst
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..723bbd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# pretix OIDC
+
+This is a plugin for [pretix](https://github.com/pretix/pretix).
+
+OIDC authentication plugin for pretix
+
+## Development setup
+
+1. Make sure that you have a working [pretix development
+ setup](https://docs.pretix.eu/en/latest/development/setup.html).
+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:
+
+ pip install flake8 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 .
+
+To automatically check for these issues before you commit, you can run
+`.install-hooks`.
+
+## License
+
+Copyright 2023 Jaakko Rinta-Filppula, Felix Schäfer
+
+Released under the terms of the Apache License 2.0
diff --git a/README.rst b/README.rst
deleted file mode 100644
index e5e862a..0000000
--- a/README.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-pretix OIDC
-==========================
-
-This is a plugin for `pretix`_.
-
-OIDC authentication plugin for pretix
-
-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::
-
- pip install flake8 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 .
-
-To automatically check for these issues before you commit, you can run ``.install-hooks``.
-
-
-License
--------
-
-
-Copyright 2023 Jaakko Rinta-Filppula, Felix Schäfer
-
-Released under the terms of the Apache License 2.0
-
-
-
-.. _pretix: https://github.com/pretix/pretix
-.. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html
diff --git a/setup.py b/setup.py
index 40f36b5..d4034f7 100644
--- a/setup.py
+++ b/setup.py
@@ -9,7 +9,7 @@ from pretix_oidc import __version__
try:
with open(
- os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf-8"
+ os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8"
) as f:
long_description = f.read()
except Exception:
@@ -30,6 +30,7 @@ setup(
version=__version__,
description="OIDC authentication plugin for pretix",
long_description=long_description,
+ long_description_content_type="text/markdown",
url="https://gitlab.fachschaften.org/kif/pretix-oidc",
author="Jaakko Rinta-Filppula, Felix Schäfer",
author_email="admin@kif.rocks",
--
GitLab