kiara plugin: (dh_tagung_2023)

Examples, code and documentation for the DH Tagung 2023 kiara workshop.

• Documentation: https://DHARPA-Project.github.io/kiara_plugin.dh_tagung_2023
• Code: https://github.com/DHARPA-Project/kiara_plugin.dh_tagung_2023
• kiara: https://dharpa.org/kiara.documentation

Description

TODO

Development

Requirements

• Python (version >= 3.8)
• pip, virtualenv
• git
• make (on Linux / Mac OS X -- optional)

Prepare development environment

If you only want to work on the modules, and not the core Kiara codebase, follow the instructions below. Otherwise, please check the notes on how to setup a Kiara development environment under (TODO).

Linux & Mac OS X (using make)

For *NIX-like operating system, setting up a development environment is relatively easy:

git clone https://github.com/DHARPA-Project/kiara_plugin.dh_tagung_2023.git
cd kiara_plugin.dh_tagung_2023
python3 -m venv .venv
source .venv/bin/activate
make init

Windows (or manual pip install)

It's impossible to lay out all the ways Python can be installed on a machine, and virtual- (or conda-)envs can be created, so I'll assume you know how to do this. One simple way is to install the Anaconda (individual edition), then use the Anaconda navigator to create a new environment, install the 'git' package in it (if your system does not already have it), and use the 'Open Terminal' option of that environment to start up a terminal that has that virtual-/conda-environment activated.

Once that is done, cd into a directory where you want this project folder to live, and do:

# make sure your virtual env is activated!!!
git clone https://github.com/DHARPA-Project/kiara_plugin.dh_tagung_2023.git
cd kiara_plugin.dh_tagung_2023
pip install --extra-index-url https://pypi.fury.io/dharpa/ -U -e .[all_dev]

Try it out

After this is done, you should be able to run the included example module via:

kiara run dh_tagung_2023_example text_1="xxx" text_2="yyy"
...
...

Re-activate the development environment

The 'prepare' step from above only has to be done once. After that, to re-enable your virtual environment, you'll need to navigate to the directory again (wherever that is, in your case), and run the source command from before again:

cd path/to/kiara_plugin.dh_tagung_2023
source .venv/bin/activate  # if it isn't activated already, for example by the Anaconda navigator
kiara --help  # or whatever, point is, kiara should be available for you now,

make targets (Linux & Mac OS X)

• init: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)
• update-dependencies: update development dependencies (mainly the core kiara package from git)
• flake: run flake8 tests
• mypy: run mypy tests
• test: run unit tests
• docs: create static documentation pages (under build/site)
• serve-docs: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentation
• clean: clean build directories

For details (and other, minor targets), check the Makefile.

Running tests

> make test
# or
> make coverage

Copyright & license

This project is MPL v2.0 licensed, for the license text please check the LICENSE file in this repository.