Getting started

Install SnapAPI

Install pysnapapi from PyPI. That gives you a snapapi command inside the venv. Or skip this and use the playground.

From PyPI

macOS / Linux

python3 -m venv .venv
source .venv/bin/activate
pip install pysnapapi
snapapi --version

Windows

py -3 -m venv .venv
.venv\Scripts\activate
pip install pysnapapi
snapapi --version

You’re looking for a line like snapapi 0.3.0. Then go to Quick start — you can paste the files, no clone required.

If it fails

• command not found / not recognized — venv isn’t active. Activate it, or run .venv/bin/snapapi (Windows: .venv\Scripts\snapapi).
• externally-managed-environment — system Python blocked a global pip. Use the venv above.
• You installed snapapi and got a FastAPI/SNAP payments library — uninstall it, then pip install pysnapapi.

From this repository (contributors)

git clone https://github.com/deekshith-poojary98/snapapi.git
cd snapapi
python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[dev]"
snapapi --version

.[dev] adds pytest. pip install -e ".[watch]" adds watchdog for snapapi watch.

pip install -r requirements.txt
pip install -e .

Exit codes when you run suites: 0 everything passed, 1 a test failed, 2 parse or usage error (missing file included).