Trustpoint Development environment setup¶

Installation¶

Trustpoint uses the Python Django framework.

We are using uv to manage different python versions and dependencies.

Please note that the current version is in development status and still subject to major changes. Our aim is to make an operational version of the software available quickly in order to receive as much feedback as possible from users.

Install uv¶

You should use uv to create a virtual environment and to manage the dependencies (instead of pip directly).

Check out the official documentation for the installer.

In simple cases, installing uv is as straightforward as:

pip install uv

Install dependencies with uv¶

If you have an existing virtual environment, e.g. through using python3 -m venv, exit the virtual environment (that is make sure you are not in the environment). You can usually exit it with:

deactivate

Then, remove any virtual environment you may have set up, e.g. .venv/ directory.

Finally, install everything through uv:

cd /path/to/trustpoint/
uv sync

Activating the environment¶

It is generally not required to manually activate the virtual environment, just start your command with uv run instead of python. However, if you do want to activate the environment manually, you can do so using

source .venv/bin/activate

Usage¶

Setting up the DB and SuperUser¶

The development server supports a PostgreSQL database by default. The connection settings can be configured in the settings.py file. If the configured database is not available, the server will fall back to a built-in SQLite database.

Next, it is required to migrate (creating the required tables) and create a superuser. The superuser credentials admin/testing321 can later be used to access the Trustpoint user interface at localhost:8000.

cd trustpoint
uv run manage.py reset_db

Finally, compile the translation strings for non-English language support:

uv run manage.py compilemsg -l de

Running the development server¶

uv run manage.py runserver

You can then access the GUI through localhost:8000.

You can also specify a different port by appending it to the command, e.g.:

uv run manage.py runserver 0.0.0.0:8080

Alternatively, use the following command to run a development HTTPS server (self-signed certificate).

uv run manage.py runserver_plus 0.0.0.0:443 --cert-file ../tests/data/x509/https_server.crt --key-file ../tests/data/x509/https_server.pem

A self-signed TLS server certificate is already provided in the test data directory. If you need to regenerate it (e.g., with different IP addresses or hostnames), use the following command:

uv run manage.py create_tls_certs

Note: The command generates a certificate with predefined IP addresses (127.0.0.1, 192.168.88.10) and hostnames (localhost, trustpoint.local). Modify the command source code to customize these values.

Running development server with background task worker¶

For testing features that require background task processing (e.g., cyclic CRL generation), use the following command to start both the development server and Django-Q2 qcluster together:

uv run manage.py runserver_with_qcluster

This starts both processes in parallel and handles shutdown gracefully with Ctrl+C.

Alternatively, you can start them separately in different terminals:

# Terminal 1: Start the development server
uv run manage.py runserver

# Terminal 2: Start the Django-Q2 worker
uv run manage.py qcluster

Logging in¶

Browsing to any page should redirect you to the login page. The login page can be accessed directly via /users/login/.

Use the username and password which you previously provided through the createsuperuser command.

Management commands for testing and development purposes¶

uv run manage.py reset_db

Clears the database and restores Trustpoint to the initial state.

uv run manage.py add_domains_and_devices

Populates the database with an example CA, domain and device instances.

uv run manage.py makemsg -l de
uv run manage.py makemsg -l de -d djangojs

Makes the translation (.po) files from translatable strings. gettext must be installed on your system.

uv run manage.py compilemsg -l de

Compiles the translation files (.po) to binary (.mo) files actually used by Django.

Building auto documentation¶

uv sync --group docs
cd ../docs
sphinx-apidoc -f -e -o ./source ../trustpoint /*/migrations/*
make html
open build/html/index.html

Adding dependencies to the project¶

Dependencies generally required for the project can be added using the following:

uv add <name-of-package>

Dependencies that are only required in development, use the following to add in within the dev section:

uv add <name-of-package> --dev

Testing & CI¶

Using the ruff linter and formatter¶

For linting everything in the current directory use:

uv run ruff check . --output-format=concise

For active formatting everything in the current directory use:

uv run ruff format .

For type checking, we use mypy:

uv run mypy .

Running pytest unit tests¶

Trustpoint uses pytest to run self-contained tests, either unit tests or integration tests that do not involve a request-response cycle:

uv run pytest

Running BDD tests with behave¶

Trustpoint uses behave to run BDD tests. The tests are located in the features/ directory:

uv run manage.py behave

Before committing checklist¶

Before pushing your changes, ensure the following:

Format your code with ruff:
```
uv run ruff format .
```

Lint your code with ruff:

uv run ruff check . --output-format=concise

Check type annotations with mypy:
```
uv run mypy .
```
Run all tests:
```
uv run pytest
```

Run migrations if you modified models:

cd trustpoint
uv run manage.py makemigrations

Check for merge conflicts in migration files:
```
git status
```
If there are duplicate migrations (e.g., multiple 0003_tp_v0_5_0_dev1.py files), combine them before committing.
Verify database state by running:
```
cd trustpoint
uv run manage.py reset_db
```
This ensures your changes work with a fresh database.

Editor configuration¶

We recommend using Visual Studio Code as the editor for Trustpoint development. To ensure the recommended settings are correctly loaded, please ensure that you open the project via the .code-workspace file:

code .vscode/trustpoint.code-workspace

Alternatively, use “File -> Open Workspace from File…” in the menu bar.

Please place project-specific settings in the trustpoint.code-workspace file. The .vscode/settings.json file is ignored by git and is intended for user-specific configuration.