You're reading an old version of this documentation. For up-to-date information, please have a look at v0.2.

Developer documentation

Welcome to the developer documentation of the ASpecD framework. Unlike the API documentation, this part gives some general background information for developers who want to actively contribute to the project.

Virtual environment

The whole development should take place inside a virtual python environment that should be located outside the project directory.

To create a new virtual python environment, open a terminal and change to a a directory where the virtual environment should reside. Then type something like:

virtualenv aspecd

or alternatively:

python3 -m venv aspecd

This will create a virtual environment in the directory “ASpecD”. To activate this virtual environment, use:

source aspecd/bin/activate

To deactivate, the command would simply be:

deactivate

Autoincrementing version numbers

The version number is contained in the file VERSION in the project root directory. To automatically increment the version number with every commit, use a git hook that calls the file bin/incrementVersion.sh. Git hooks reside in the directory .git/hooks. The simplest would be to create a new file pre-commit in this directory with the following content:

#!/bin/sh
bash bin/incrementVersion.sh

Make sure to set it to executable and have a line break (aka: new or empty line) at the end of the file. Otherwise, you man run into trouble, i.e., not having your version number updated automatically with each commit.

Directory layout

The ASpecD framework follows good practice of the Python community regarding directory layout. As there will be several subpackages available, these reside each in a separate directory containing its own __init__.py file. All packages/modules reside below the ASpecD directory of the project root. The tests directory follows the same structure and contains all the module tests. Generally, the ASpecD framework should be developed test-driven (test-first) as much as possible.

(This) documentation resides inside the docs directory of the project root. The auto-generated API documentation is in its own directory.

A general overview of the overall package structure:

bin/
docs/
    api/
aspecd/
tests/

As you can see, currently there exists one subpackage, namely “io”, but others will soon be created as well. For details of the ASpecD framework as such, consult its Homepage.

Docstring format

The Docstring format used within the code of the ASpecD framework is “NumPy”. For convenience, set your IDE accordingly.

For PyCharm, the settings can be found in Preferences > Tools > Python Integrated Tools. Here, you find a section “Docstrings” where you can select the Docstring format from a number of different formats.

Unittests and test driven development

Developing the ASpecD framework code should be done test-driven wherever possible. The tests reside in the tests directory in the respective subpackage directory (see above).

Tests should be written using the Python unittest framework. Make sure that tests are independent of the respective local environment and clean up afterwards (using appropriate teardown methods).

Setting up the documentation build system

The documentation is built using Sphinx, Python. Building requires using a shell, for example bash.

To install the necessary Python dependencies, create a virtual environment, e.g., with virtualenv <environment>, and activate it afterwards with <environment>/bin/activate. Then install the dependencies using pip:

pip install sphinx
pip install sphinx-rtd-theme

To build the documentation:

  • Activate the virtual environment where the necessary dependencies are installed in.

  • cd to docs/, then run make html. (To clean previously built documentation, run make clean first).

Static code analysis with Prospector

Static code analysis can be performed using Prospector. First, install the necessary tools into the virtual environment created for the ASpecD framework:

pip install prospector[with_pyroma]

The optional arguments ensure that all necessary dependencies are installed as well.

Afterwards, simply run Prospector from a terminal from within your project root:

prospector

It will display the results of the static code analysis within the terminal. Settings can be changed in the .prospector.yaml file in the project root, but please be very careful changing settings here. Often, it is better to (temporarily) silence warnings in the code itself.