Install SDETKit¶
Use this page to choose an install mode quickly before your first run.
Python 3.10+ is required.
After install, continue with: - Fast onboarding: Quickstart (copy-paste) - Guided run: First run quickstart (canonical)
Choose an install mode¶
| If you need... | Use this mode |
|---|---|
| Project-local, repeatable setup (recommended for most users/teams) | venv |
| Isolated global CLI-style install | pipx |
| Local development of this repository | Local source install |
Do not rely on bare system pip install ... on Ubuntu/WSL; it may fail with an externally-managed-environment error. Use venv or pipx instead.
Recommended: venv (project-local, first-time friendly)¶
python3.10 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install sdetkit==1.0.3
python -m sdetkit --help
pipx (isolated app-style install)¶
pipx install sdetkit==1.0.3
pipx run sdetkit --help
Local source install (contributors in this repo)¶
python3.10 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install .
python -m sdetkit --help
Runtime contract check (adopters and CI)¶
Use the runtime contract command to confirm stable install/run surfaces:
python -m sdetkit contract runtime --format json
External repository usage (canonical handoff)¶
From the root of the repository you want to gate:
python -m sdetkit gate fast
python -m sdetkit gate release
python -m sdetkit doctor
Then continue with: - Quickstart (copy-paste) - First run quickstart - Release confidence explainer
Development setup (this repository only)¶
If you are contributing to SDETKit itself:
bash scripts/bootstrap.sh
source .venv/bin/activate
python -m pip install -e .[dev,test,docs]
This setup is for contributors/maintainers and is not required for external adoption.