Merge pull request #28 from martindurant/django

Add django project

Author: martindurant

docs/source/api.rst

@@ -46,6 +46,7 @@ User Classes
     proj.pyscript.PyScript
     proj.rust.Rust
     proj.rust.RustPython
+    proj.webapp.Django
     proj.webapp.Streamlit
     proj.uv.UvScript
     proj.uv.Uv
@@ -69,6 +70,7 @@ User Classes
 .. autoclass:: projspec.proj.pyscript.PyScript
 .. autoclass:: projspec.proj.rust.Rust
 .. autoclass:: projspec.proj.rust.RustPython
+.. autoclass:: projspec.proj.webapp.Django
 .. autoclass:: projspec.proj.webapp.Streamlit
 .. autoclass:: projspec.proj.uv.UvScript
 .. autoclass:: projspec.proj.uv.Uv

src/projspec/artifact/process.py

@@ -9,9 +9,9 @@ class Process(BaseArtifact):
     Can include batch jobs and long-running services.
     """
 
-    def _make(self):
+    def _make(self, **kwargs):
         if self.proc is None:
-            self.proc = subprocess.Popen(self.cmd, **self.kw)
+            self.proc = subprocess.Popen(self.cmd, **kwargs)
 
     def _is_done(self) -> bool:
         return self.proc is not None and self.proc.poll() is None

src/projspec/proj/__init__.py

@@ -12,7 +12,7 @@
 from projspec.proj.python_code import PythonCode, PythonLibrary
 from projspec.proj.rust import Rust, RustPython
 from projspec.proj.uv import Uv
-from projspec.proj.webapp import Streamlit
+from projspec.proj.webapp import Django, Streamlit
 
 __all__ = [
     "ParseFailed",
@@ -36,6 +36,7 @@
     "RTD",
     "Rust",
     "RustPython",
+    "Django",
     "Streamlit",
     "Uv",
     "VSCode",

src/projspec/proj/webapp.py

@@ -1,4 +1,38 @@
-from projspec.proj import ProjectSpec
+from projspec.proj import ProjectSpec, ParseFailed
+
+
+class Django(ProjectSpec):
+    """A python web app using the django framework"""
+
+    def match(self):
+        return "manage.py" in self.proj.basenames
+
+    def parse(self) -> None:
+        from projspec.artifact.process import Server
+
+        # global settings are in ./*/settings.py in a directory also containing urls.py
+        # the top-level; manage.py may have the line to locate it:
+        # os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
+        # and "mysite" is the suggestion in the tutorials;
+        # can also be given as --settings to manage.py
+        allpy = self.proj.fs.glob(f"{self.proj.url}/*/*.py")
+
+        # We could also choose to parse the settings or URLs - but they are required
+        s_dirs = {_.rsplit("/", 1)[0] for _ in allpy if _.endswith("settings.py")}
+        u_dirs = {_.rsplit("/", 1)[0] for _ in allpy if _.endswith("urls.py")}
+        maindir = s_dirs.intersection(u_dirs)
+        if not maindir:
+            raise ParseFailed
+
+        # each site is a subdirectory with admin.py and other stuff, typically
+        # each mapped to a different sub-URL.
+        appdirs = [_.rsplit("/", 2)[-2] for _ in allpy if _.endswith("admin.py")]
+        if appdirs:
+            self.contents["apps"] = appdirs
+
+        self.artifacts["server"] = Server(
+            proj=self.proj, cmd=["python", "manage.py", "runserver"]
+        )
 
 
 class Streamlit(ProjectSpec):
@@ -56,6 +90,9 @@ def parse(self) -> None:
 
 
 # TODO: the following are similar to streamlit, but with perhaps even less metadata
+# - flask (from flask import Flask; app = Flask( )
+# - fastapi (from fastapi import FastAPI; app = FastAPI( )
 # - plotly/dash (from dash import Dash; app = Dash(); app.run())
 # - voila (this is just a way to display a notebook)
 # - panel (import panel as pn; .servable())
+# Each of these takes extra parameters for listen address and port at least.