Update README.md, and various related changes

.env.template

@@ -3,11 +3,14 @@
 ############################
 
 # Should be set to the name of the postgres container
-POSTGRES_HOST="hyperion-db"
 POSTGRES_USER=""
 POSTGRES_PASSWORD=""
+# Should be set to the name of the postgres container
+POSTGRES_HOST=""
 POSTGRES_DB="hyperion"
 POSTGRES_TZ="Etc/UTC"
+# The database can be accessed through the command line with
+# psql -U $POSTGRES_USER -d $POSTGRES_DB
 
 ########################
 # Redis configuration #
@@ -16,8 +19,8 @@ POSTGRES_TZ="Etc/UTC"
 # We use the default redis configuration, so the protected mode is enabled by default (see https://redis.io/docs/manual/security/#protected-mode)
 # If you want to use a custom configuration, a password and a specific binds should be used to avoid security issues
 
-# May be left at "" during dev if you don't have a redis server running, in production it should be set to the name of the redis container
-REDIS_HOST="hyperion-redis"
+# REDIS_HOST may be commented to disable Redis during development if you don't have a redis server running, in production it should be set to the name of the redis container
+#REDIS_HOST="localhost"
 REDIS_PORT=6379
 # Should be commented during development to work with docker-compose-dev, and set in production
 #REDIS_PASSWORD=""

.github/workflows/lintandformat.yml

@@ -26,7 +26,7 @@ jobs:
         uses: actions/[email protected]
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-uv-${{ hashFiles('requirements-common.txt', 'requirements-dev.txt') }}
+          key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-uv-${{ hashFiles('requirements.txt', 'requirements-dev.txt') }}
 
       - name: Install uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh

.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
           - 6379:6379
       postgres:
         # Docker Hub image
-        image: postgres
+        image: "postgres:15.1"
         # Provide the password for postgres
         env:
           POSTGRES_PASSWORD: "somerealpassword"
@@ -57,14 +57,14 @@ jobs:
         uses: actions/setup-python@v6
         id: setup-python
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: Cache uv folder
         id: cache-uv
         uses: actions/[email protected]
         with:
           path: ~/.cache/uv
-          key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-uv-${{ hashFiles('requirements-common.txt', 'requirements-dev.txt') }}
+          key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-uv-${{ hashFiles('requirements.txt', 'requirements-dev.txt') }}
 
       - name: Install uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh

.gitignore

@@ -1,39 +1,36 @@
 # Cache folders
-__pycache__
-.mypy_cache
-.pytest_cache
-.ruff_cache
-
-# Databases and data
-sql_app.db
-test.db
+__pycache__/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+
+# Databases (PostgreSQL and SQLite)
+hyperion-db/
+*.db
+
+# Persistent data as files
 data/
 
-# Dotenv file
+# Configuration and secrets files
 .env
 config.yaml
-
-
-# Firebase secrets
 firebase.json
 
 # macOS
 .DS_Store
 
 # Virtual environment
-.venv
-.python-version
+.venv/
 
 # Logs
 logs/
 
 # Pytest-cov
 .coverage
 
-# Jinja templates test output
+# Jinja output templates and test output
 tests/jinja_test_outputs/
+node_modules/
 
 # Local testing
 scripts/
-
-node_modules

.python-version

@@ -0,0 +1 @@
+3.12.11

.vscode/extensions.json

@@ -1,7 +1,8 @@
 {
-    "recommendations": [
-        "ms-python.python",
-        "ms-python.mypy-type-checker",
-        "charliermarsh.ruff",
-    ]
-}
+  "recommendations": [
+    "ms-python.python",
+    "ms-python.mypy-type-checker",
+    "charliermarsh.ruff",
+    "tamasfe.even-better-toml"
+  ]
+}

.vscode/launch.json

@@ -9,7 +9,7 @@
       "type": "debugpy",
       "request": "launch",
       "module": "fastapi_cli",
-      "args": ["dev", "app/main.py"],
+      "args": ["dev"],
       "jinja": true,
       "justMyCode": true
     }

Dockerfile

@@ -20,10 +20,10 @@ RUN groupadd --gid 1000 hyperion && \
 WORKDIR /hyperion
 
 # First copy only the requirements to leverage Docker cache
-COPY requirements-common.txt .
+COPY requirements.txt .
 
 # Install dependencies using uv (way faster than pip)
-RUN uv pip install --system --no-cache -r requirements-common.txt
+RUN uv pip install --system --no-cache -r requirements.txt
 
 # Then copy the rest of the application code
 COPY alembic.ini .
@@ -43,4 +43,4 @@ EXPOSE 8000
 
 # Use fastapi cli as the entrypoint
 # Use sh -c to allow environment variable expansion
-ENTRYPOINT ["sh", "-c", "fastapi run app/main.py --workers $WORKERS --host 0.0.0.0 --port 8000"]
+ENTRYPOINT ["sh", "-c", "fastapi run --workers $WORKERS --host 0.0.0.0 --port 8000"]