Installation
Requirements
Python 3.11 or newer
pip
The assembler is bundled with the compiler.
From PyPI
python3 -m pip install niblick
For the VS Code language server:
python3 -m pip install "niblick[lsp]"
From a checkout
python3 -m venv .venv
.venv/bin/python -m pip install -e ".[dev]"
For compiler use only:
python3 -m pip install -e .
Optional extras
Extra |
Contents |
|---|---|
|
Test suite, type checking, coverage, property tests, dependency audit |
|
VS Code language server |
|
Sphinx, MyST, Read the Docs theme, live rebuild |
The optional upstream emulator cross-check uses the direct Git dependency in
requirements-fidelity.txt:
python3 -m pip install -r requirements-fidelity.txt
python3 -m pip install -e ".[docs]"
Verify
python3 -m niblick examples/hello.nbl --run
The command writes examples/hello.asm and examples/hello.hex and runs the
program in the emulator.