aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-07-25 21:48:03 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-07-25 22:05:20 +0200
commit9470c9236ee91299414a5e33e582648c5385156a (patch)
treebb6200220cb3da552ff64ba43a7a2565f53013e8
parentFix and harden linter checks. (diff)
downloadmu4web-9470c9236ee91299414a5e33e582648c5385156a.tar.gz
mu4web-9470c9236ee91299414a5e33e582648c5385156a.tar.xz
Add entry point and README.
-rw-r--r--README.md18
-rw-r--r--mu4web/__main__.py11
2 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28a60b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+Mu4Web
+======
+
+Running
+-------
+
+### Development
+
+ python -m mu4web
+
+### Deployment
+
+The project should be deployed through some form of WSGI gateway.
+
+A minimal [Gunicorn](https://gunicorn.org/) example:
+
+ gunicorn 'mu4web.main:app'
+
diff --git a/mu4web/__main__.py b/mu4web/__main__.py
new file mode 100644
index 0000000..18b8bf6
--- /dev/null
+++ b/mu4web/__main__.py
@@ -0,0 +1,11 @@
+"""
+Mu4web entry point for development.
+
+This runs mu4web on port 8091. For deployment environments, use
+something like gunicorn.
+"""
+
+from .main import app
+
+if __name__ == '__main__':
+ app.run(debug=True, port=8091)