Developer Guide#
This guide explains how to develop PyExasol and run tests.
Initial Setup#
Switch to a supported Python version:
poetry env use python3.13
Create a virtual environment and install dependencies:
poetry install --all-extras
Run the following command to enter the virtual environment:
eval "$(poetry env activate)"
Once you have set up all dependencies and activated the poetry shell, all further tasks for development should be available via the task runner nox. To see all available tasks, run the following command: nox --list.
To execute a specific task, run nox -s <task name>. For example, nox -s test:unit.
In our CI, PyExasol is checked for various formatting & type checks with nox tasks. To run these more easily locally, we’ve added a .pre-commit-config.yaml, which you can activate with pre-commit
poetry run -- pre-commit install --hook-type pre-commit --hook-type pre-push
Unit Tests#
nox -s test:unit
If you want to forward additional arguments to pytest, you need to pass --
to indicate the end of the argument vector for the nox command. For example:
nox -s test::unit -- -k meta
Preparing & Triggering a Release#
The exasol-toolbox provides nox tasks to semi-automate the release process:
# prepare a release
nox -s release:prepare -- --type {major,minor,patch}
# trigger a release
nox -s release:trigger
For further information, please refer to the exasol-toolbox’s page Creating a Release.