User Guide

Exasol’s Python Toolbox (PTB) helps you creating and maintaining your Python projects.

PTB simplifies keeping all of your projects up-to-date, secure, without bugs, using uniform code style and formatting, correctly typed, decent quality wrt. static code analysis, nicely documented, and equipped with a unified CI/CD pipeline for building, testing, and publishing their artifacts.

The PTB gains its name from employing a series of well-established tools to satisfy these goals:

  • Bandit for detecting security vulnerabilities

  • Black and Ruff for source code formatting

  • Cookiecutter for setting up new projects from a uniform template

  • Coverage for measuring code coverage by tests

  • Mypy for static type checking

  • Nox for using the tools via a common CLI

  • Pip Audit for known vulnerabilities in dependencies

  • Poetry for packaging and managing dependencies

  • Pylint / Ruff for linting

  • Sonar for reporting code quality based on the findings by other tools

  • Sphinx for generating the documentation

In rare cases you may need to disable a particular finding reported by one of these tools, see Troubleshooting.