CONTRIBUTING.md

Contribution Guide

Dev setup

Activate virtual env:

python3 -m venv .venv
source .venv/bin/activate

Then install the dev requirements:

pip install -r ./requirements-dev.txt

Testing

Run tests with tox:

tox -epy312

Updating kubernetes-client version

1. Update DEFAULT_BRANCH in scripts/stubgen.py
2. Update requirements-test.txt version pin and pip install it.
3. Regenerate stubs and model dicts

Generating stubs

Stubs are generated using stubgen

To regenerate stubs run:

python ./scripts/stubgen.py

Generating model dicts

Do this:

python ./scripts/typeddictgen.py

Publishing

Add and push a new tag:

git tag v18.20.2rc1
git push origin --tags