kiara data-types and modules for working with tables and databases.

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

TODO

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

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).

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

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

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.tabular.git
cd kiara_plugin.tabular
pip install --extra-index-url https://pypi.fury.io/dharpa/ -U -e .[all_dev]

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

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

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.tabular
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,

• 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.

> make test
# or
> make coverage

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