A set of modules (and pipelines) for Kiara.
Project description
kiara plugin: (core-types)
Core data types for kiara.
- Documentation: https://DHARPA-Project.github.io/kiara_plugin.core_types
- Code: https://github.com/DHARPA-Project/kiara_plugin.core_types
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.core_types.git
cd kiara_plugin.core_types
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.core_types.git
cd kiara_plugin.core_types
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 core_types_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.core_types
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 corekiara
package from git)flake
: run flake8 testsmypy
: run mypy teststest
: run unit testsdocs
: create static documentation pages (underbuild/site
)serve-docs
: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentationclean
: 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kiara_plugin.core_types-0.4.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94ba2d004ffeb484be4e07e16f2fa8b9ebab55636014e3f27891e57deb4e58ec |
|
MD5 | 29e238c62603af990d231e1bf406f54f |
|
BLAKE2b-256 | 58f15a07e2c68d1ae1a0de4d9f13973e2a2257725a24c9c4a8d24c8b561852ab |
Hashes for kiara_plugin.core_types-0.4.10-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6459ecfa70d23c269d07b6e0a177e2aca827c9b7bf09bcdceda9d485da6ab6ff |
|
MD5 | 5d5338d0ee6429402453ba98204da83c |
|
BLAKE2b-256 | e381426aa10ff1c996bd70973cf80772ab4a386fc36450aa630dbb302dd097e0 |