Local Build & Run¶
This page describes how to set up a local environment, install Cullinan in editable mode, run tests, and start example applications on Windows (PowerShell), Linux, and macOS.
Prerequisites¶
- Python 3.8 or newer
- Git
Clone the repository¶
On all platforms:
git clone https://github.com/plumeink/Cullinan.git
cd Cullinan
Create and activate a virtual environment (optional but recommended)¶
On Windows (PowerShell):
python -m venv .venv
.venv\Scripts\Activate.ps1
On Linux / macOS:
python -m venv .venv
source .venv/bin/activate
Install dependencies in editable mode¶
On all platforms:
python -m pip install -U pip
pip install -e .
If you have additional development extras configured in setup.py or pyproject.toml, you can install them as needed, for example:
pip install -e .[dev]
Run the test suite¶
On all platforms:
pytest -q
If your environment uses a different test runner, adapt the command accordingly (e.g. python -m pytest).
Run an example application¶
Hello HTTP example¶
On Windows (PowerShell):
python examples\hello_http.py
On Linux / macOS:
python examples/hello_http.py
Then open http://localhost:4080/hello in a browser to verify the server is running.
Middleware demo¶
On Windows (PowerShell):
python examples\middleware_demo.py
On Linux / macOS:
python examples/middleware_demo.py
Refer to the middleware documentation for a description of the expected log output and behavior.