development.txt

Commands needed for setting up a development environment, building wheels,
and uploading to PyPI

# Development environment

## Create the development environment, only needed once
python3 -m venv devenv

## Activate the development environment
source ./devenv/bin/activate

## Install the module locally using the source in-place
python3 -m pip install --editable .

# Testing

The package must be installed to be tested because the C library
must be compiled and this is done during packaging.

python3 -m pip install pytest robot
pytest
robot -F robot robot

Note that the robot tests are fragile, relying on fixed configuration
files, and external programs like `sed` and `msi` (and it's output formatting),
which may or may not be present or the right versions.  These are not expected
to run on Windows.

# Generate documentation

Documentation generated from the code can be updated with the following script:

% make-help.docs.sh

Some documentation is generated and others are static within the `docs`
directory.  See docs/README.txt for more details.

# Update release version

The single-source package version is specified in:
src/rover/__version__.py

Release versions must also be tagged on the main branch at release time.

The versioning follows the semantic versioning definition.

# Building distribution packages

## Ensure required build modules are installed
python3 -m pip install build twine

## Build sdist
python3 -m build --sdist

## Test and upload to PyPI
python3 -m twine check --strict dist/*
python3 -m twine upload dist/*