Thalia Website¶

The latest Thalia Website built on Django.

Getting started¶

If you use Docker, please look at this part of the README.

Get at least Python 3.7 and install poetry and the Pillow requirements as per below.
Clone this repository
Make sure poetry uses your Python 3.x installation: poetry env use python3
Run poetry install
Run poetry shell
cd website
./manage.py migrate to initialise the database
./manage.py createsuperuser to create the first user (note that this user won’t be a member!)
./manage.py createfixtures -a to generate a bunch of test data
./manage.py runserver to run a testing server
Go to the user you created and complete the profile and add a membership for full access

Testing and linting¶

You can use pyenv (on Unix systems) to test in different python environments.

All code has to be run through black before being committed. To black the code before committing make run black one the base directory of this project. If you want to integrate black with your editor look in the black docs. On linux you can find the black executable in ~/.cache/poety/virtualenvs/<your env>/bin/black.

There are a range of tests that can be run:

poetry run python website/manage.py check
poetry run python website/manage.py templatecheck --project-only
poetry run python website/manage.py makemigrations --no-input --check --dry-run
poetry run coverage run website/manage.py test website/
poetry run coverage report

poetry¶

Install poetry per the poetry documentation. Make sure you install at least version 1.x.x.

Pillow dependencies¶

For Ubuntu 18.04, use:

apt-get install python3-dev gettext gcc build-essential libtiff5-dev libjpeg-turbo8-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev

Or try:

apt-get build-dep python3-pil

For other operating systems, see the Pillow Documentation.

On macOS you will also need to install libmagic, using the brew package manager by running brew install libmagic.

Thabloid dependencies¶

To be able to generate JPGs from PDFs, we need ghostscript:

apt-get install ghostscript

Or for macOS:

brew install ghostscript

Translating¶

Make sure to use British English.

To create translations for your app:

cd into the application’s directory
../manage.py makemessages --locale nl --no-obsolete
This creates or updates locale/nl/LC_MESSAGES/django.po
Start poedit by calling poedit locale/nl/LC_MESSAGES/django.po
../manage.py compilemessages (should happen automatically when saving the file in poedit)
Commit both the .po and .mo file to the repository

Settings¶

The settings of our project are located in website/thaliawebsite/settings. This is a Python module that loads the included settings files based on the environment you are running in.

If DJANGO_PRODUCTION is set in the environment production.py will be included
If GITHUB_ACTIONS is set in the environment testing.py will be included
If localsettings.py exists it will be included, you can use this to override settings on your local development server without the risk of committing secrets.

settings.py contains the default included settings.

Documentation¶

The documentation for our code is located inside the files and is combined using Sphinx into an HTML output. The continuous integration checks if the latest Python modules are included in the Sphinx files located in the docs folder

To update these files:

cd docs into the application’s directory
Run poetry install -E docs to install the dependencies
Run ./generate-apidocs.sh to update the .rst documents

If you have a localsettings.py then make sure you do not commit this part of the documentation to version control.

Docker¶

First run with Docker:

docker-compose up -d
docker-compose run web migrate
docker-compose run web createsuperuser

Step 1. may take a while since docker-compose needs to retrieve all dependencies and build the Docker images. Step 2. creates the necessary tables and step 3. creates a superuser, as the command implies.

After step 3. you can access the Thalia website locally through http://localhost:8000/