Contributing

I’m not a coder!

Submit an issue explaining the issue throughly. Not everyone can code and there is no shame in that.

End of the day, world+dog wants featureful well written packages which stay on mission and within the resources and talent at the teams disposal.

Issues and PRs

Create an issue first. Get feedback. And if the feedback is favorable, do the work and submit a PR, in a branch, with a mention to the issue.

The trick is to keep the commit scope as small as possible. Ideally should do only one thing.

New features

The rules might get tossed aside. Take risk; be bold.

Expect feedback asking for changes. Be patient, make whatever changes are requested.

Setup venvs

Will be setting up two venv

Table 15 Virtual environments

code base	Python version
docs	py310
package	py39

Assumes using pyenv

docs venv

pyenv

mkdir .doc
cd .doc
pyenv versions

Assuming py310 version is 3.10.14

touch .python-version
echo "3.10.14" > .python-version

Check active version

pyenv version

3.10.14

setup docs venv and install dependencies

cd .doc
mkdir .venv
python -m venv .venv
. .venv/bin/activate
python -m pip install -r ../docs/pip-tools.lock
python -m pip install -r ../docs/requirements.lock

Build a package

Update docs requirements

activate doc venv then run

cd docs
make doc_upgrade

package venv

.python-version goes into the package base folder parent, not the package base folder

pyenv version

3.9.16

mkdir .venv
python -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements/pip-tools.lock
python -m pip install -r requirements/prod.lock
python -m pip install -r requirements/kit.lock
python -m pip install -r requirements/manage.lock
python -m pip install -r requirements/dev.lock

Everything except docs

Update package requirements

activate package venv then run

make upgrade

Setup – tox

pyenv installed versions

pyenv versions

The .tox/.python-version needs all the versions tox will have access to

mkdir .tox
cd .tox
touch .python-version
cat <<-EOF > .python-version
3.9.16
3.10.14
3.11.9
3.12.4
pypy3.10-7.3.16
EOF

Assuming package venv is already activated

python -m pip install -r requirements/tox.lock

Then use tox

tox -r -e lint
tox -r -e mypy
tox -r -e pre-commit
tox -r -e interrogate
cd .tox && tox -r --root=.. -c ../tox-test.ini -e pypy3 --workdir=.; cd - &>/dev/null
tox -r -e docs

-r long form is --recreate. tox only needed to recreate venv when dependencies change. Or whenever feel the itch.

For running coverage, python version can be changed, e.g. -e pypy3.