Developer Guide

Setup Development Environment

  1. Install pip3 and development dependencies:

    sudo python3
    sudo pip3 install tox flake8 pep8-naming
  2. Install a C/C++ toolchain for native extensions and cythonized binary wheel packaging:

    sudo apt install python3-dev build-essential cmake graphviz
  3. Optionally, it is recommended to install the webdev package to run a development web server from a local directory:

    sudo pip3 install webdev
    webdev .tox/doc/tmp/html

Building Package

tox -e build

Output will be available at dist/.

  • Source distribution: tse2sql-<version>.tar.gz.

  • Python wheel: tse2sql-<version>-py3-none-any.whl

  • Binary wheel: tse2sql-<version>-cp35-cp35m-linux_x86_64.whl


The tags of the binary wheel will change depending on the interpreter and operating system you build the binary wheel on.

Running Test Suite

tox -e test

Output will be available at .tox/test/tmp/.

webdev .tox/doc/tmp/
  • Test results: tests.xml.

  • Coverage results: coverage.xml.

  • Coverage report: coverage.html.

Building Documentation

tox -e doc

Output will be available at .tox/doc/tmp/html.

webdev .tox/doc/tmp/html