Hacking on Kotori


We’re happy you reached this point. You mean it. Let’s go.

For the auxiliary infrastructure (Mosquitto, InfluxDB, Grafana), you might want to have a look at the Docker infrastructure sandbox. This relies on boot2docker and makes us happy when used on Mac OSX.

When running Linux, you might just want to install the infrastructure on your local workstation natively like Setup on Debian.

Getting started

Get the source code

mkdir -p develop; cd !$
git clone https://github.com/daq-tools/kotori.git
cd kotori

Setup virtualenv

make virtualenv
source .venv2/bin/activate
python setup.py develop

# Install extra features

# Data acquisition base
pip install --process-dependency-links --editable .[daq] --verbose

# Data acquisition base, with export features
pip install --process-dependency-links --editable .[daq,export] --verbose

# Data acquisition with data sink for binary payloads
pip install --process-dependency-links --editable .[daq_binary] --verbose

# Data storage for RDBMS databases and MongoDB
pip install --process-dependency-links --editable .[storage_plus] --verbose

Please follow virtualenv.

Run on PyPy

sudo port install pypy
virtualenv --python=pypy .venvpypy5
source .venvpypy5/bin/activate
python setup.py develop
pip install -e .[daq]

Run ad hoc

Please follow Kotori Handbook.


Add Project to PyCharm by using “Open Directory…”

There’s a Free Community edition of PyCharm, you should really give it a try.

Run as service

When having the desire to run the application as system service even while being in development mode, have a look at Kotori development with systemd. We actively use this scenario for integration scenarios, testing and debugging.