Skip to content

Installation

Install from PyPI

pip install neksus-jobspec

Local development setup

git clone https://github.com/NeksusAI/NeksusJobSpec.git
cd NeksusJobSpec
uv sync

Install documentation dependencies

pip install -r requirements-docs.txt

Serve docs locally

mkdocs serve

Build docs locally

mkdocs build --strict

Verify project setup

uv run pytest
uv run ruff check .
uv run ruff format --check .
uv run neksus-jobspec version

Useful local commands

uv run pytest -q
uv run pytest tests/test_cli_spec_validate.py -x
uv run neksus-jobspec init
uv run neksus-jobspec check

Smoke test

./scripts/smoke.sh

3-layer local test run

uv run pytest -m "not integration"
./scripts/smoke.sh
uv run pytest -m integration