Running from Source

Environment Setup

• Python 3.12.
• uv is recommended.
• A Windows development environment.

git clone https://github.com/BnanZ0/ok-nte.git
cd ok-nte
uv sync

Starting the Application

# Production entry point
python main.py

# Debug entry point with more detailed logs
python main_debug.py

Tests and Static Checks

The repository uses unittest. When a local virtual environment is available, prefer its interpreter:

.\.venv\Scripts\python.exe -m unittest discover -s tests -p "*.py"
.\.venv\Scripts\python.exe -m py_compile src\flow.py

If Ruff is installed, you can run:

ruff check .

Building the Documentation Site

Documentation dependencies are separate from application dependencies. After installation, you can generate HTML that can be hosted by any static web server:

.\.venv\Scripts\python.exe -m pip install -r requirements-docs.txt
.\.venv\Scripts\python.exe -m mkdocs build --strict

The default output directory is site/. To preview the site locally:

.\.venv\Scripts\python.exe -m mkdocs serve