Ruff linting/formatting

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build and Push
+on:
+  push:
+    branch:
+      - master
+
+jobs:
+  Build-And-Push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Get app version
+        run:
+          echo "heltour_version=$(grep "^version = \"\(.*\)\"" pyproject.toml | sed 's/^.*"\(.*\)"/\1/')" >> "$GITHUB_ENV"
+      - name: Build
+        run: |
+          docker build --target app -t heltour:latest .
+          docker build --target static -t heltour-static:latest .
+      - name: Tag
+        run: |
+          docker tag heltour:latest ghcr.io/Lichess4545/heltour:latest
+          docker tag heltour-static:latest ghcr.io/Lichess4545/heltour-static:latest
+          docker tag heltour:latest ghcr.io/nicwest/Lichess4545:$heltour_version
+          docker tag heltour-static:latest ghcr.io/nicwest/Lichess4545-static:$heltour_version
+      - name: Log in to registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+      - name: Push
+        run: |
+          docker push ghcr.io/Lichess4545/heltour:latest
+          docker push ghcr.io/Lichess4545/heltour-static:latest
+          docker push ghcr.io/Lichess4545/heltour:$heltour_version
+          docker push ghcr.io/Lichess4545/heltour-static:$heltour_version

.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: Lint and Test
+on: [push]
+jobs:
+  Lint-And-Test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: ci
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+          cache: 'poetry'
+      - name: Install dependencies
+        run:
+          poetry install --with dev
+      - name: Lint
+        run: |
+          poetry run ruff format --check heltour/
+          poetry run ruff check heltour/
+      - name: Test
+        run:
+          poetry run python manage.py test --settings=heltour.settings_test
+        env:
+          DJANGO_DB_HOST: 127.0.0.1
+          DJANGO_DB_PORT: 5432
+          DJANGO_DB_NAME: postgres
+          DJANGO_DB_USER: postgres
+          DJANGO_DB_PASS: ci
+          DJANGO_CACHE_URL: redis://127.0.0.1:6379/1
+          DJANGO_CACHEOPS_URL: redis://127.0.0.1:6379/1
+          CELERY_BROKER_URL: redis://127.0.0.1:6379/2

.gitignore

@@ -1,14 +1,19 @@
 *.pyc
 env
+venv
 .project
 .pydevproject
 /static
 /media
 certs
 celerybeat-schedule
+celerybeat-schedule.db
 *eclipse*
 data
 .idea
 .sass-cache
 /heltour/tournament/static/tournament/css/*.css
 /heltour/tournament/static/tournament/css/*.css.map
+javafo.jar
+heltour/local/
+.DS_Store

Dockerfile

@@ -0,0 +1,27 @@
+FROM python:3.11-slim AS build
+ENV HELTOUR_APP=tournament
+WORKDIR /usr/src/heltour
+
+RUN apt-get update && \
+    apt-get install -y gcc libpq-dev libffi-dev && \
+    apt-get clean 
+
+RUN pip install poetry
+RUN poetry config virtualenvs.create false
+
+COPY pyproject.toml poetry.lock ./
+
+RUN poetry install --with server
+
+COPY manage.py .
+COPY heltour/ ./heltour
+
+RUN poetry install
+RUN python manage.py collectstatic
+
+FROM nginx AS static
+COPY --from=build /usr/src/heltour/static /usr/share/nginx/html
+
+FROM build AS app
+CMD ["gunicorn", "-t", "300", "-w", "4", "-b", "0.0.0.0:8000", "heltour.wsgi:application"]
+

Makefile

@@ -0,0 +1,57 @@
+.PHONY: docker-build server migrate collectstatic init docker-run up up-deps celery loaddata dbshell shell
+
+export DJANGO_DB_HOST=127.0.0.1
+export DJANGO_DB_PORT=5432
+export DJANGO_DB_NAME=local
+export DJANGO_DB_USER=local
+export DJANGO_DB_PASS=password
+export DJANGO_SETTINGS_MODULE=heltour.settings_development
+export DJANGO_CACHE_URL=redis://127.0.0.1:6379/1
+export DJANGO_CACHEOPS_URL=redis://127.0.0.1:6379/1
+export CELERY_BROKER_URL=redis://127.0.0.1:6379/2
+
+test:
+	python manage.py test
+
+server:
+	python manage.py runserver
+
+celery:
+	celery -A heltour worker -B -c 1 --loglevel INFO -O fair
+
+migrate:
+	python manage.py migrate
+
+dbshell:
+	python manage.py dbshell
+
+shell:
+	python manage.py shell
+
+collectstatic:
+	python manage.py collectstatic
+
+createsuperuser:
+	python manage.py createsuperuser
+
+loaddata:
+	python manage.py loaddata users leagues
+
+init: collectstatic migrate createsuperuser
+
+docker-build:
+	docker build --target app -t lichess4545/heltour:latest .
+	docker build --target static -t lichess4545/heltour-static:latest .
+
+docker-run:
+	docker run -p 8000:8000 lichess4545/heltour:latest
+	docker run -p 8001:80 lichess4545/heltour-static:latest
+
+up:
+	docker compose up
+
+up-deps:
+	docker compose up redis postgres
+
+up-deps-d:
+	docker compose up -d redis postgres 

README.md

@@ -1,33 +1,51 @@
 # heltour
 League management software for the Lichess4545 league.
 
-# requirements
-* Python
-* Pip
-* poetry
-* Postgres (Ubuntu packages postgresql and postgresql-server-dev-9.5)
-* Fabric (pip install fabric)
-* Virtualenv (Ubuntu package virtualenv)
-* [Sass](https://sass-lang.com/install)
+## Setup
 
-# install
-These install instructions have been test on Arch and Ubuntu linux. Other OSes should work, but the install may vary slightly.
+* [Install docker](https://docs.docker.com/get-started/get-docker/)
+* in a terminal run the following command:
+```shell
+docker compose up -d redis postges
+docker compose run web python manage.py migrate --settings=heltour.settings_development
+docker compose run web python manage.py createsuperuser --settings=heltour.settings_development
+Username (leave blank to use 'root'): admin
+Email address: admin@example.com
+Password: <put whatever here>
+Password (again): <if it complains just ignore it!>
+Superuser created successfully.
+docker compose up web
+```
 
-1. Create a local settings file. In the heltour/local folder, copy one of the existing modules and name it "host_name.py" where "host_name" is your machine's hostname (with non-alphanumeric characters replaced by underscores).
-2. `./start.sh`
-3. `source env/bin/activate`
-4. `fab up`
-5. `fab createdb`
-6. `fab -R dev latestdb`
-8. `fab runserver`
+### Optional Components
+- To generate pairings, download [JaVaFo](http://www.rrweb.org/javafo/current/javafo.jar) and set JAVAFO_COMMAND to 'java -jar /path/to/javafo.jar'
 
-# development
-Use [4545vagrant](https://github.com/lakinwecker/4545vagrant) as development environment.
 
-Ensure that your editor has an [EditorConfig plugin](https://editorconfig.org/#download) enabled.
+## Environmental variables
 
-# create admin account
-Run `python manage.py createsuperuser` to create a new admin account.
+| Name | Default | Description |
+|-|-|-|
+| `DJANGO_SECRET_KEY` | `abc123` | a super secret key that django needs you to keep safe |
+| `DJANGO_DEBUG` |  `FALSE` | puts django into debug mode, useful for local developement but definately needs to be off in production |
+| `DJANGO_TESTING` | `FALSE` | tells the code we are running tests. |
+| `DJANGO_LOGGING_CONFIG` | | django logging config in JSON format. if no config is provided will default to sensible norms |
+| `DJANGO_LOGGING_LEVEL` | `DEBUG` | assuming that no logging config is provided, this variable controls the log level of django's logging |
+| `DJANGO_DATABASE_CONFIG` | | django database config in JSON format. if no config is provided the application will assume a single postgres database, and look for additional configuration information from the environment |
+| `DJANGO_DB_HOST` | `localhost` | the database host |
+| `DJANGO_DB_PORT` | `5432` | the database port |
+| `DJANGO_DB_NAME` |  | the database name |
+| `DJANGO_DB_USER` |  | the database user |
+| `DJANGO_DB_PASS` |  | the database password |
+| `DJANGO_CACHE_URL` | `redis://localhost:6379/1` | the redis URL for django's caching |
+| `DJANGO_CACHEOPS_URL` | `redis://localhost:6379/1` | the redis URL for cacheops |
+| `CELERY_BROKER_URL` | `redis://localhost:6379/1` | the redis URL for the celery broker |
+| `HELTOUR_LINK_PROTOCOL` | `https` | the protocol to use when making requests to other parts of the application, set to `http` for local development |
+| `HELTOUR_APP` |  | set to `API_WORKER` to enable the api worker instead of the main web app |
+| `HELTOUR_API_WORKER_HOST` | `https://localhost:8800` | the host for the API worker app |
+| `HELTOUR_GOOGLE_SERVICE_ACCOUNT_KEYFILE_PATH` |  | path to service account key for accessing google services |
+| `HELTOUR_SLACK_API_TOKEN_FILE_PATH` | | path to file containing the slack API token |
+| `HELTOUR_SLACK_WEBHOOK_FILE_PATH` | | ??? |
+| `HELTOUR_LICHESS_API_TOKEN_FILE_PATH` | | path to file containing the lichess API token |
+| `HELTOUR_FCM_API_KEY_FILE_PATH` | | ??? |
+| `HELTOUR_STAGING` | `False`| indicates that we are in the staging environment (or not!)|
 
-### Optional Components
-- To generate pairings, download [JaVaFo](http://www.rrweb.org/javafo/current/javafo.jar) and set JAVAFO_COMMAND to 'java -jar /path/to/javafo.jar'

docker-compose.yaml

@@ -0,0 +1,71 @@
+services:
+  web:
+    build: .
+    ports:
+      - "8000:8000"
+    command: ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+    environment:
+      DJANGO_DB_HOST: postgres
+      DJANGO_DB_PORT: 5432
+      DJANGO_DB_USER: local
+      DJANGO_DB_PASS: password
+      DJANGO_SETTINGS_MODULE: heltour.settings_development
+      DJANGO_CACHE_URL: redis://redis:6379/1
+      DJANGO_CACHEOPS_URL: redis://redis:6379/1
+      CELERY_BROKER_URL: redis://redis:6379/2
+      HELTOUR_API_WORKER_HOST: http://apiworker:8000
+
+    develop:
+      watch:
+        - action: sync
+          path: .
+          target: /usr/src/heltour
+  celery:
+    build: .
+    command: ["celery", "-A", "heltour", "worker", "-B", "-c", "1", "--loglevel", "INFO", "-O", "fair"]
+    environment:
+      DJANGO_DB_HOST: postgres
+      DJANGO_DB_PORT: 5432
+      DJANGO_DB_USER: local
+      DJANGO_DB_PASS: password
+      DJANGO_SETTINGS_MODULE: heltour.settings_development
+      DJANGO_CACHE_URL: redis://redis:6379/1
+      DJANGO_CACHEOPS_URL: redis://redis:6379/1
+      CELERY_BROKER_URL: redis://redis:6379/2
+
+    develop:
+      watch:
+        - action: sync
+          path: .
+          target: /usr/src/heltour
+
+  apiworker:
+    build: .
+    command: ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+    environment:
+      DJANGO_DB_HOST: postgres
+      DJANGO_DB_PORT: 5432
+      DJANGO_DB_USER: local
+      DJANGO_DB_PASS: password
+      DJANGO_SETTINGS_MODULE: heltour.settings_development
+      DJANGO_CACHE_URL: redis://redis:6379/1
+      DJANGO_CACHEOPS_URL: redis://redis:6379/1
+      CELERY_BROKER_URL: redis://redis:6379/2
+      HELTOUR_APP: API_WORKER
+    develop:
+      watch:
+        - action: sync
+          path: .
+          target: /usr/src/heltour
+
+  redis:
+    image: "redis:alpine"
+    ports:
+      - 6379:6379
+  postgres:
+    image: "postgres:alpine"
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_USER: local
+      POSTGRES_PASSWORD: password

heltour/api_worker/urls.py

@@ -1,8 +1,9 @@
-from django.conf.urls import url
+from django.urls import path
+
 from . import views
 
 urlpatterns = [
-    url(r'^lichessapi/(?P<path>.+)$', views.lichess_api_call, name='lichess_api_call'),
-    url(r'^watch/$', views.watch, name='watch'),
-    url(r'^watch/add/$', views.watch_add, name='watch_add'),
+    path("lichessapi/<path:path>", views.lichess_api_call, name="lichess_api_call"),
+    path("watch/", views.watch, name="watch"),
+    path("watch/add/", views.watch_add, name="watch_add"),
 ]