README.md

Artemis Client

Installation

pip install git+https://github.com/kit-sdq/artemis_client@main

Configuration

The client can be configured either by configuration file or by environment variables.

• Provide a file 'config.ini' in the working directory
• Provide a file 'config.ini' in a custom directory and set ARTEMIS_CLIENT_CONFIG environment variable accordingly
• Provide all configuration options as environment variables (SECTION_KEY)
• Supply username and password using the Session constructor

Values found in environment variables are preferred over configuration files. That can be used to provide credentials in a testing environment, for example.

Setting up a development environment

This project uses poetry:

poetry install

Testing

poetry run tox  # thats all

Folder layout

This project uses the "Tests outside application code" layout presented here (sources in src folder).

Build the docs

You can build the documentation using sphinx:

poetry run tox -e docs

The docs can then be found in .tox/docs_out