clean up

Author: SKairinos

.github/workflows/main.yml

@@ -29,6 +29,8 @@ jobs:
     if: |
       github.repository_owner_id == 2088731 &&
       github.ref_name == github.event.repository.default_branch
+    env:
+      CONFIG: releaserc.toml
     steps:
       - name: 🛫 Checkout
         uses: actions/checkout@v4
@@ -59,7 +61,7 @@ jobs:
         run: |
           PYTHON_SCRIPT="from codeforlife import __version__; print(__version__)"
           echo OLD_VERSION=$(python -c "$PYTHON_SCRIPT") >> $GITHUB_ENV
-          semantic-release version
+          semantic-release --config=${{ env.CONFIG }} version
           echo NEW_VERSION=$(python -c "$PYTHON_SCRIPT") >> $GITHUB_ENV
 
       - name: 🏗️ Build Distributions
@@ -70,7 +72,7 @@ jobs:
         if: env.OLD_VERSION != env.NEW_VERSION
         env:
           GH_TOKEN: ${{ secrets.CFL_BOT_GH_TOKEN }}
-        run: semantic-release publish
+        run: semantic-release --config=${{ env.CONFIG }} publish
 
       - name: 🚀 Publish to PyPI
         if: env.OLD_VERSION != env.NEW_VERSION

.vscode/settings.json

@@ -8,7 +8,7 @@
   },
   "black-formatter.args": [
     "--config",
-    "pyproject.toml"
+    "../configs/backend/pyproject.toml"
   ],
   "black-formatter.path": [
     ".venv/bin/python",
@@ -37,23 +37,23 @@
     "**/__pycache__": true
   },
   "isort.args": [
-    "--settings-file=pyproject.toml"
+    "--settings-file=../configs/backend/pyproject.toml"
   ],
   "isort.path": [
     ".venv/bin/python",
     "-m",
     "isort"
   ],
   "mypy-type-checker.args": [
-    "--config-file=pyproject.toml"
+    "--config-file=../configs/backend/pyproject.toml"
   ],
   "mypy-type-checker.path": [
     ".venv/bin/python",
     "-m",
     "mypy"
   ],
   "pylint.args": [
-    "--rcfile=pyproject.toml"
+    "--rcfile=../configs/backend/pyproject.toml"
   ],
   "pylint.path": [
     ".venv/bin/python",
@@ -65,7 +65,7 @@
     "-n=auto",
     "--cov=.",
     "--cov-report=html",
-    "-c=pyproject.toml",
+    "-c=../configs/backend/pyproject.toml",
     "."
   ],
   "python.testing.pytestEnabled": true,

manage.py

@@ -2,44 +2,27 @@
 © Ocado Group
 Created on 12/04/2024 at 16:53:51(+01:00).
 
-This file manages Django but also acts a settings file.
+Django's command-line utility for administrative tasks.
 """
 
-# pylint: disable-next=wildcard-import,unused-wildcard-import
-from codeforlife.settings import *
-
-# NOTE: This is only used locally for testing purposes.
-SECRET_KEY = "XTgWqMlZCMI_E5BvCArkif9nrJIIhe_6Ic6Q_UcWJDk="
-
-INSTALLED_APPS = [
-    "django.contrib.admin",
-    "django.contrib.auth",
-    "django.contrib.contenttypes",
-    "django.contrib.sessions",
-    "django.contrib.messages",
-    "django.contrib.staticfiles",
-    "django.contrib.sites",
-    "codeforlife.user",
-    "game",  # TODO: remove this
-    "common",  # TODO: remove this
-    "portal",  # TODO: remove this
-]
-
-MIDDLEWARE = [
-    "codeforlife.middlewares.SessionMiddleware",
-    "django.contrib.auth.middleware.AuthenticationMiddleware",
-    "django.contrib.messages.middleware.MessageMiddleware",
-]
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+    try:
+        # pylint: disable-next=import-outside-toplevel
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
 
-ROOT_URLCONF = "codeforlife.user.urls"
 
 if __name__ == "__main__":
-    import os
-    import sys
-
-    from django.core.management import execute_from_command_line
-
-    # Set the path of the settings file to the path of this file.
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", Path(__file__).stem)
-
-    execute_from_command_line(sys.argv)
+    main()

pyproject.toml

@@ -0,0 +1,5 @@
+# https://github.com/python-semantic-release/python-semantic-release/blob/v9/docs/configuration.rst
+[semantic_release]
+version_variables = ["codeforlife/__init__.py:__version__"]
+commit_message = "v{version} [skip ci]"
+commit_author = "cfl-bot <[email protected]>"

releaserc.toml

@@ -0,0 +1,34 @@
+"""
+© Ocado Group
+Created on 14/03/2025 at 15:34:28(+00:00).
+
+The min settings required to manage the `codeforlife.user` Django app-module.
+"""
+
+# pylint: disable-next=wildcard-import,unused-wildcard-import
+from codeforlife.settings import *
+
+# NOTE: This is only used locally for testing purposes.
+SECRET_KEY = "XTgWqMlZCMI_E5BvCArkif9nrJIIhe_6Ic6Q_UcWJDk="
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django.contrib.sites",
+    "codeforlife.user",
+    "game",  # TODO: remove this
+    "common",  # TODO: remove this
+    "portal",  # TODO: remove this
+]
+
+MIDDLEWARE = [
+    "codeforlife.middlewares.SessionMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+]
+
+ROOT_URLCONF = "codeforlife.user.urls"