2024-bsc-sebastian-lenzlinger/code/iottb-project/README.md

Iottb

Installation

There are a few different ways to install iottb.

In Linux, to install to a users local bin directory using poetry or pip:

• Move into the project root cd path/to/iottb-project, so that you are in the directory which contains the pyproject.toml file.

poetry install --editable
# or with pip
pip install -e .

Currently this is the recommended method. Alternatively install with pip into any activated environment:

pip install -r requirements.txt

It is possible to make a single executable for you machine wich you can just put in your path using pyinstaller.

1. Install pyinstaller

pip install pyinstaller 

2. Make the executable

pyinstaller --onefile iottb/main.py

To be able to run it as iottb rename it to iottb and put it somewhere on your PATH. Currently this method has bugs, since some python standard library names do not seem to be compiled into the executable.

Basic Invocation

Configuration

Env Vars

• IOTTB_CONF_HOME

By setting this variable you control where the basic iottb application configuration should be looked for