Development

This chapter contains information helpful when you want to engage in development of this project.

Prerequisites

If you want to engage in development of this project you should have the following libraries and tools available.

Tools

Libraries

  • unixodbc

  • unixodbc-dev

  • libboost-date-time-dev

  • libboost-locale-dev

  • libboost-system-dev

Example: Install of required system libraries on Ubuntu

sudo apt-get install unixodbc unixodbc-dev libboost-date-time-dev libboost-locale-dev libboost-system-dev

Locale

Make sure the local is setup appropriately.

Example: Setting up an english locale

sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && locale-gen
export LANG=en_US.UTF-8

Project Layout

Attention

Currently it is required that the integration-test-docker-environment project is checked out in parallel to this project. For more details on this have a look at the Settings in noxfile.py

Expected Layout:

|-sqlalchemy-exasol/
├─ ...
|-integration-test-docker-environment
├─ ...
|
...

Setup Your Workspace

Get The Source

git clone https://github.com/exasol/sqlalchemy-exasol.git

Setup the Tooling & Virtual Environment

poetry shell
poetry install

Warning

make sure you have the poetry shell active whenever you want to work in the workspace

Install the Git Commit Hooks

pre-commit install

Note

This may need to be rerun if you want or do add non standard hook types, for further details see pre-commit install -h.

Task Runner (Nox)

Most repeating and complex tasks within this project are automated using the task runner nox. To get an overview about the available tasks just run:

nox -l

All task(s) which will be run by default will have a leading *. In order to run a specific task execute the following command:

nox -s <task-name>

You can modify or add new task by editing the file noxfile.py.

Tests

  1. Install all python dependencies needed for development

    # make sure you are using the virtual environment poetry has setup for this project
poetry shell

  2. Run all tests with pyodbc connector

    nox

    or

    nox -s "verify(connector='pyodbc')"

  3. Run all tests with turbodbc connector

    nox -s "verify(connector='turbodbc')"

Attention

If something still is not working or unclear, you may want to look into the CI/CD action files.

Changelog (scriv)

What, why and from whom to write a changelog you can read up on keepachangelog, in this section we just want give the information on how to keep track of fragments which later will be used to create the changelog on the next published release.

For the bookkeeping and generation of the changelog we use scriv, so if you find the information in this section not sufficient we recommend to consult the scriv documentation.

Note

keep in mind that all our docs, including the changelog are in the restructuredText format when you format your entries.

Run the following command to create a new changelog fragment.

scriv create --edit

An editor will open and you get prompted with a template, uncomment sections headings you need and add your entries below. Also make sure you commit the created fragment once you’re done.

Note

To make sure you won’t forgetting to commit the fragment, you can use the –add flag to automatically add it to the git index.

scriv create --edit --add