Installation
Install the Python SDK. The CLI nitrostack-py ships in the same package.
Requirements
- Python: 3.10 or newer (generated projects pin
.python-versionto 3.12) - OS: macOS, Linux, or Windows
- Recommended: uv on
PATHfor lockfiles anduv sync
Install the SDK and CLI
Bash
pip install nitrostack
Verify:
Bash
nitrostack-py --help
# equivalent:
python -m nitrostack.cli.main --help
Editable / local checkout:
Bash
pip install -e .
pip install -e ".[dev]" # pytest, httpx, tox, …
What gets installed
| Name | Purpose |
|---|---|
nitrostack | Core SDK: modules, tools, resources, prompts, auth, widgets, testing |
nitrostack-py | CLI: init, dev, start, pack, generate, install, upgrade, validate, register |
There is no separate @nitrostack/cli or @nitrostack/widgets npm package for Python. Widgets are static HTML files under widgets/out/.
Scaffold a project (recommended)
Bash
nitrostack-py init my-server --template python-starter
init writes pyproject.toml, .python-version, uv.toml, and .env, then runs uv lock when uv is available. nitrostack-py install prefers uv sync.
If you skip install (--skip-install), run:
Bash
cd my-server
nitrostack-py install
Agent skills
init clones skills-python-sdk into agent folders (.cursor/skills, .claude/skills, .codex/skills, and others) and records skillsVersion in .nitrostack.json. nitrostack-py upgrade refreshes skills when the registry version bumps. Use --force on init to overwrite existing skill directories.