feat: add pypi deployment worklow

.github/workflows/pypi.yml

@@ -0,0 +1,35 @@
+name: PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+          cache: "poetry"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U twine
+          poetry install
+
+      - name: Build package
+        run: poetry build
+
+      - name: Upload to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+          TWINE_NON_INTERACTIVE: true

MANIFEST.in

@@ -0,0 +1,5 @@
+include CHANGELOG.md
+include LICENSE
+recursive-include LICENSES *
+global-exclude *.py[co]
+global-exclude __pycache__

alexandria/settings/__init__.py

@@ -1 +1 @@
-from .django import *
+from .django import *  # noqa

alexandria/settings/alexandria.py

@@ -1,10 +1,16 @@
+"""
+This settings module only contains alexandria specific settings.
+
+It's imported by the main alexandria settings and is intended to also be used by third party
+applications integrating alexandria.
+"""
+
 import os
-import re
 
 import environ
 
 env = environ.Env()
-django_root = environ.Path(__file__) - 2
+django_root = environ.Path(__file__) - 3
 
 ENV_FILE = env.str("ENV_FILE", default=django_root(".env"))
 if os.path.exists(ENV_FILE):

alexandria/settings/django.py

@@ -3,8 +3,7 @@
 from django.conf import global_settings
 
 from .alexandria import *  # noqa
-from .alexandria import default, django_root, env, environ
-
+from .alexandria import default, env, environ
 
 SECRET_KEY = env.str("SECRET_KEY", default=default("uuuuuuuuuu"))
 DEBUG = env.bool("DEBUG", default=default(True, False))
@@ -22,7 +21,7 @@
     "alexandria.core.apps.DefaultConfig",
 ]
 
-if ENV == "dev":
+if ENV == "dev":  # noqa
     INSTALLED_APPS.append("django_extensions")
 
 MIDDLEWARE = [
@@ -118,6 +117,10 @@ def parse_languages(languages):
     "TEST_REQUEST_DEFAULT_FORMAT": "vnd.api+json",
 }
 
+JSON_API_FORMAT_FIELD_NAMES = "dasherize"
+JSON_API_FORMAT_TYPES = "dasherize"
+JSON_API_PLURALIZE_TYPES = True
+
 # Anonymous writing
 ALLOW_ANONYMOUS_WRITE = env.bool("ALLOW_ANONYMOUS_WRITE", default=False)