CONTRIBUTING.md

Contributing

To test changes on a branch that haven't been released yet, you'll have to pull down the branch and install the SDK/CLI in editable mode using pip intall -e. Navigate to the incydr_python directory and to install from your local path (rather than from a released version on PyPI) use:

pip install -e .

To install the CLI extension in a similar manner:

pip install -e .'[cli]'

Note! Using pyenv but its not picking up the version? Try running

eval "$(pyenv init -)"

Install hatch

The Incydr SDK uses Hatch as its Python project manager.

pip install hatch

Run style checks

hatch run style:check

Run the style check action without printing the diff.

hatch run style:check-no-diff

Run tests

Run tests with a coverage report:

hatch run test:cov

Run tests without a coverage report:

hatch run test:no-cov

Serve docs locally

hatch run docs:serve

To just build the docs:

hatch run docs:build