Installation

For Users

Using uv

uv tool install nyxmon

For Developers

Prerequisites

  • Python 3.12 or higher

  • uv package manager

Development Setup

  1. Install Python (3.12 or higher):

uv python install

  1. Create a virtual environment:

uv venv

  1. Install dependencies and local packages in editable mode:

uv sync

  1. Install pre-commit hooks:

uvx pre-commit install

  1. Run tests:

uv run pytest

  1. Run static analysis:

uv run mypy src/

Database Setup

Before running the application, run the database migrations:

uv run src/django/manage.py migrate

This creates an SQLite database file in the project root directory.

Next Steps

See Usage for information on running the application.