feat: add module system (#5)

OMAP can now be started via a config system.
More informations can be found in the README.
Extend gitignore
Renamed PortalModule to OmapModule

Author: JulianFeinauer

.gitignore

@@ -129,3 +129,4 @@ dmypy.json
 .pyre/
 
 !omap/theme/static/css/dist/
+/.idea/

README.md

@@ -8,3 +8,23 @@ Speaking of roles, we usually distinguish between **Machine Manufacturers**, i.e
 The *OMAP* project aims especially at pushing the cooperation of all involved parties over machine data to build ecosystems that lead to a gain for all involved parties.
 
 Documentation can be found on [readthedocs](https://omap.readthedocs.io/en/latest/).
+
+## Start the OMAP
+
+OMAP relies on a module system which extends Django Apps.
+Just start it with the omap.py script (which is pretty similar to manage.py).
+
+```
+python omap.py runserver
+```
+or
+```
+./omap.py runserver
+```
+
+After this start it behaves exactly like a regular django project.
+So migrations can e.g. be done via
+```
+./omap.py migrate
+```
+etc...

omap.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+from omap.modules import modules
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "omap.launcher.settings")
+    # Here we set the OMAP_MODULES env varible, if not set
+    os.environ.setdefault("OMAP_MODULES", "")
+
+    # Here we inject our custom settings
+    modules.configure_modules()
+    try:
+        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)
+
+
+if __name__ == "__main__":
+    main()

omap/core/apps.py

@@ -4,3 +4,5 @@
 class CoreConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
     name = "omap.core"
+
+    url_prefix = "core"

omap/launcher/settings.py

@@ -41,9 +41,6 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    "tailwind",
-    "omap.core",
-    "omap.assets",
 ]
 
 MIDDLEWARE = [
@@ -111,8 +108,6 @@
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
-TAILWIND_APP_NAME = "omap/core"
-
 INTERNAL_IPS = [
     "127.0.0.1",
 ]

omap/launcher/urls.py

@@ -1,7 +1,37 @@
+import importlib
+import logging
+
+from django.apps import apps
+from django.conf import settings
 from django.conf.urls import url, include
+from django.conf.urls.static import static
 from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [url(r"admin/", admin.site.urls)] + (
+    static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+    if settings.MEDIA_ROOT
+    else []
+)
+
+"""
+Here, apps are registered automatically with their urls if they have a property "url_prefix" set in their AppConfig
+AND if they have a valid urls.py file which sets a variable urlpatterns
+"""
+for config in apps.get_app_configs():
+    if hasattr(config, "url_prefix"):
+        logging.debug(f"Found url_prefix in {config.name}, checking for .urls module")
+        urls_path = config.module.__name__ + ".urls"
+        try:
+            mod = importlib.import_module(urls_path)
+        except ModuleNotFoundError:
+            logging.debug(f"No url module found under {urls_path}", exc_info=True)
+            continue
+
+        logging.debug(
+            f"urls.py present under {urls_path}, setting for prefix {config.url_prefix}"
+        )
+        # Do the include
+        urlpatterns.append(path(config.url_prefix + "/", include(urls_path)))
 
-urlpatterns = [
-    url("", include("omap.core.urls")),
-    url(r"admin/", admin.site.urls),
-]
+logging.debug(f"Patterns: {urlpatterns}")

omap/modules/__init__.py

@@ -0,0 +1,3 @@
+"""
+Contains all necessary code for the module system which allows for OMAPs module system to have pluggable apps.
+"""