The 2nd Great Homebrew Project

.github/workflows/linter.yml

@@ -0,0 +1,32 @@
+name: Linter
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+      - name: Install project
+        run: poetry install --no-interaction
+      - name: Run tests
+        run: |
+          poetry run ruff check

DEVELOPMENT.md

@@ -0,0 +1,107 @@
+# Local Development
+
+## Database
+
+The site uses PostgreSQL as the backend database. The mimimum PostgreSQL version required in v13. The PostgreSQL database must have the `postgresql-contrib` debian installed. It is recommended that you use [docker compose](./dev/docker-compose.yml) to spin up the [attached Dockerfile](./dev/Dockerfile) as your PostgreSQL database.
+
+In order to test the "Name" and "Author" search fields, you must apply the following migration to your database once it has been deployed.
+
+```python
+from django.contrib.postgres.operations import TrigramExtension
+from django.db import migrations
+
+class Migration(migrations.Migration):
+    operations = [
+        TrigramExtension()
+    ]
+```
+
+## Python environment
+
+This project uses `poetry` to manage python dependencies. Follow the [Poetry installation instructions](https://python-poetry.org/docs/#installation) to install poetry.
+
+Note: Users have reported getting stuck in the install, running `export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring` may fix this.
+
+You can then install python environment using `poetry install`
+
+### Creating the Config
+
+By default, `manage.py` looks for the file `botc/local.py`. You must create a `botc/local.py` with the following content:
+
+```python
+from .settings import *
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": "postgres",
+        "HOST": "localhost",
+        "USER": "postgres@db",
+        "PASSWORD": "postgres",
+    }
+}
+
+SECRET_KEY = "<random_string>"
+
+STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
+BS_ICONS_CACHE = os.path.join(STATIC_ROOT, "icon_cache")
+DEBUG = True
+
+INTERNAL_IPS = [
+    "127.0.0.1",
+    "localhost",
+]
+
+```
+
+Be sure to choose your own random string for the `SECRET_KEY`. [You can generate one here](https://randomkeygen.com/). 
+
+If you are not using the docker compose PostgreSQL database then you'll need to configure the `DATABASES` entry above with your own credentials.
+
+## Running and Migration
+
+Per the usual Django development instructions, you need to apply the migrations to the database before running, create the static files and admin account. Run 
+
+1. `poetry run python manage.py migrate`
+1. `poetry run python manage.py collectstatic`
+1. `poetry run python manage.py createsuperuser`
+
+You can also populate the database with all the characters (this is useful for testing some function), but you will need to upload your own scripts (some script data may come at a later date)
+
+`poetry run python manage.py loaddata dev/characters`
+
+The site can be run using:
+
+`poetry run python manage.py runserver`
+
+The site will be accessible at `http://localhost:8000`. You can access the Django admin panel, logging in with the credentials you used to create the super user at `http://localhost:8000/admin`
+
+## Live Debugging
+
+If you use VSCode for as your IDE, you can use the following `settings.json` to launch the website in debug mode so that you can step through code
+
+```json
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "justMyCode": false,
+            "name": "Python: Django",
+            "type": "python",
+            "request": "launch",
+            "program": "manage.py",
+            "args": [
+                "runserver"
+            ],
+            "django": true
+        }
+    ]
+}
+```
+
+## Linting
+
+This project uses [Ruff](https://docs.astral.sh/ruff/#ruff) for linting. The GitHub workflow includes a lint using ruff, but before submitting any code for review, please ensure that ruff passes by running `poetry run ruff check`

botc/production.py

@@ -1,6 +1,6 @@
 import os
 
-from .settings import *
+from .settings import * # noqa
 
 # Configure the domain name using the environment variable
 # that Azure automatically creates for us.
@@ -55,7 +55,7 @@
 AZURE_STATIC_CONTAINER = os.environ.get("AZURE_STATIC_CONTAINER", "static")
 STATIC_URL = f"https://{AZURE_CUSTOM_DOMAIN}/{AZURE_STATIC_CONTAINER}/"
 
-STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
+STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles") # noqa
 BS_ICONS_CACHE = os.path.join(STATIC_ROOT, "icon_cache")
 
 ACCOUNT_DEFAULT_HTTP_PROTOCOL = "https"

botc/urls.py

@@ -17,4 +17,7 @@
 from django.contrib import admin
 from django.urls import include, path
 
-urlpatterns = [path("admin/", admin.site.urls), path("", include("scripts.urls"))]
+urlpatterns = [
+    path("admin/", admin.site.urls), 
+    path("", include("scripts.urls")),
+]

dev/Dockerfile

@@ -0,0 +1,3 @@
+FROM postgres:latest
+
+RUN apt-get update && apt-get install -y postgresql-contrib

dev/docker-compose.yml

@@ -0,0 +1,9 @@
+services:
+  db.postgres:
+    build: .
+    restart: always
+    environment:
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_USER: postgres@db
+    ports:
+     - 5432:5432