added README.md + main.py

.env.template

@@ -0,0 +1,3 @@
+DJANGO_SECRET_KEY=
+DJANGO_ENV=prod
+DJANGO_HOSTS=localhost,127.0.0.1

.gitignore

@@ -1,2 +1,3 @@
 __pycache__
-db.sqlite3
+/db.sqlite3
+/.env

README.md

@@ -0,0 +1,87 @@
+# Time Dispatcher
+
+### Table of contents
+<!-- TOC -->
+* [Prerequisites](#prerequisites)
+* [Installation](#installation)
+* [Run the app](#run-the-app)
+  * [Production](#production)
+  * [Development](#development)
+* [Updating](#updating)
+<!-- TOC -->
+
+---
+
+**Time Dispatcher** is a QoL tool to help you track, analyze and allocate your time spent on various projects.
+Here is a list of the main features available :
+- Import tasks, projects and time imputations from CSV (compatible with [Super Productivity](https://github.com/johannesjo/super-productivity))
+- Create parents to group multiple projects
+- Track your clock-ins / -outs and/or remote work
+- Mark each parent as either productive or not, i.e. whether its projects take a share of the "clocked" time
+- Automatically compute the time that should be reported as spent on each productive parent (for example to input in SageX)
+- View your monthly working times in a nice table or in a summarized form on the dashboard
+
+## Prerequisites
+
+- Python 3+
+
+## Installation
+
+1. Clone the repository
+   ```shell
+   git clone https://git.kb28.ch/HEL/TimeDispatcher.git
+   ```
+2. Go inside the project directory
+   ```shell
+   cd TimeDispatcher/
+   ```
+3. Install the Python requirements
+   ```shell
+   pip install -r requirements.txt
+   ```
+4. Apply the database migrations
+   ```shell
+   python manage.py migrate
+   ```
+5. Set the appropriate settings in the `.env` file:
+   1. Copy `.env.template` to `.env`
+      ```shell
+      cp .env.template .env
+      ```
+   2. Fill in the settings
+      - `DJANGO_SECRET_KEY`: The secret key used by Django.
+         This is a long random string.
+         For example, it can be generated using Python with
+         ```python
+         import secrets
+         secrets.token_urlsafe(64)
+         ```
+      - `DJANGO_ENV`: Current environment, either `prod` or `dev`
+      - `DJANGO_HOSTS`: Comma-separated list of allowed hosts used by Django
+
+## Run the app
+### Production
+1. Start the Uvicorn server
+   ```shell
+   python main.py
+   ```
+2. Open [the app](http://localhost:8000/) in your browser
+
+### Development
+1. Start the Django server
+   ```shell
+   python manage.py runserver
+   ```
+2. Open [the app](http://localhost:8000/) in your browser
+
+## Updating
+(Before updating to a new version, it is recommended to back up the database file, i.e. `db.sqlite3`)
+
+To update to a new version:
+1. Download the new sources
+   - from the [release page](https://git.kb28.ch/HEL/TimeDispatcher/releases)
+   - or pull the new version with git
+2. Run the database migrations:
+   ```shell
+   python manage.py migrate
+   ```

TimeDispatcher/settings.py

@@ -9,25 +9,28 @@ https://docs.djangoproject.com/en/5.1/topics/settings/
 For the full list of settings and their values, see
 https://docs.djangoproject.com/en/5.1/ref/settings/
 """
-
+import os
 from pathlib import Path
 
+from dotenv import load_dotenv
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
-APP_VERSION = "0.0.1"
+APP_VERSION = "0.1.0"
 
+load_dotenv(BASE_DIR / ".env")
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-^*x5i_#=$9kuj6k^v0cy5dqefmzo%j*i&0w93i%!zmgsa_z)2z'
+SECRET_KEY = os.environ["DJANGO_SECRET_KEY"]
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = os.environ.get("DJANGO_ENV", "dev").lower() != "prod"
 
-ALLOWED_HOSTS = ["localhost", "192.168.2.68"]
+ALLOWED_HOSTS = list(map(lambda h: h.strip(), os.environ.get("DJANGO_HOSTS", "localhost,127.0.0.1").split(",")))
 
 
 # Application definition
@@ -57,8 +60,7 @@ ROOT_URLCONF = 'TimeDispatcher.urls'
 TEMPLATES = [
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [BASE_DIR / 'templates']
+        'DIRS': [BASE_DIR / 'templates'],
-        ,
         'APP_DIRS': True,
         'OPTIONS': {
             'context_processors': [
@@ -111,7 +113,7 @@ AUTH_PASSWORD_VALIDATORS = [
 
 LANGUAGE_CODE = 'en-us'
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = 'Europe/Zurich'
 
 USE_I18N = True
 
@@ -121,7 +123,12 @@ USE_TZ = True
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/5.1/howto/static-files/
 
+
+STATICFILES_DIRS = [
+    BASE_DIR / "dispatcher" / "static"
+]
 STATIC_URL = 'static/'
+_STATIC_ROOT = BASE_DIR / "dispatcher" / "static"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field

TimeDispatcher/urls.py

@@ -14,9 +14,10 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
-from django.contrib import admin
+from django.urls import path, register_converter, re_path
-from django.urls import path, register_converter
+from django.views.static import serve
 
+from TimeDispatcher import settings
 from TimeDispatcher.converters import DateConverter, YearMonthConverter
 from dispatcher import views
 
@@ -41,3 +42,6 @@ urlpatterns = [
     path("clockings/<date:date>/", views.set_clocking, name="set_clocking"),
     path("sagex/<int:id>/<year_month:month>/", views.set_real_sagex, name="set_real_sagex"),
 ]
+
+if not settings.DEBUG:
+    urlpatterns.append(re_path(r"^static/(?P<path>.*)$", serve, {"document_root": settings._STATIC_ROOT}))

context_processors.py

@@ -1,8 +1,9 @@
-from TimeDispatcher.settings import APP_VERSION
+from TimeDispatcher.settings import APP_VERSION, DEBUG
 
 
 def version(request):
     return {
+        "debug": DEBUG,
         "version": APP_VERSION
     }
 

dispatcher/static/base.css

@@ -77,6 +77,12 @@ footer .sep {
     height: 1em;
 }
 
+footer .debug {
+    margin-right: auto;
+    font-style: italic;
+    color: #ffb33d;
+}
+
 main {
     flex-grow: 1;
     display: flex;

dispatcher/static/error.css

@@ -0,0 +1,20 @@
+.wrapper {
+    margin: auto;
+    max-width: 25em;
+    width: 100%;
+    text-align: center;
+    display: flex;
+    flex-direction: column;
+    gap: 2em;
+}
+
+.desc {
+    line-height: 1.4;
+}
+
+.url {
+    font-family: monospace;
+    background-color: rgba(255, 255, 255, 0.11);
+    padding: 0.1em 0.4em;
+    border-radius: 4px;
+}

main.py

@@ -0,0 +1,16 @@
+import uvicorn
+
+from TimeDispatcher.asgi import application
+
+
+def main():
+    uvicorn.run(
+        application,
+        host="127.0.0.1",
+        port=8000,
+        workers=1
+    )
+
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -1,2 +1,4 @@
 Django~=5.1.5
-djangorestframework~=3.15.2
+djangorestframework~=3.15.2
+python-dotenv~=1.0.1
+uvicorn~=0.34.0

templates/404.html

@@ -0,0 +1,13 @@
+{% extends "base.html" %}
+{% load static %}
+{% block title %}404 Not Found{% endblock %}
+{% block head %}
+    <link rel="stylesheet" href="{% static "error.css" %}">
+{% endblock %}
+{% block footer %}{% endblock %}
+{% block main %}
+    <div class="wrapper">
+        <h1 class="title">Page not found</h1>
+        <p class="desc">Oops, page <span class="url">{{ request.path }}</span> could not be found. Go back to <a href="{% url "dashboard" %}">Dashboard</a></p>
+    </div>
+{% endblock %}

templates/base.html

@@ -22,6 +22,7 @@
         {% block main %}{% endblock %}
     </main>
     <footer>
+        {% if debug %}<span class="debug">Debug</span>{% endif %}
         <span><i>Time Dispatcher v{{ version }}</i></span>
         <span class="sep"></span>
         <span><a href="https://git.kb28.ch/HEL/TimeDispatcher" target="_blank">Gitea</a></span>