kiara modules for data onboarding.
Project description
kiara plugin: (onboarding)
kiara modules for data onboarding.
- Documentation: https://DHARPA-Project.github.io/kiara_plugin.onboarding
- Code: https://github.com/DHARPA-Project/kiara_plugin.onboarding
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).
Using pixi
(recommended)
The recommended way to setup a development environment is to use pixi. Check out their install instructions.
Once you have pixi
installed, you need to initialize the environment once:
pixi run install-dev-env
You also need to do this whenever a depdendency of this plugin is updated (for example the core kiara
package).
Once that is done, you can enter the environment with:
pixi shell
This will start a sub-shell with the virtual environment activated, and all dependencies of the plugin package installed. To confirm it works, you can run any kiara
command:
kiara --version
# or
kiara operation list
# or
...
...
Once you are finished with your development session, you can exit the sub-shell as you would normally do in such cases:
exit
Alternatively, you can also run the kiara
executable directly, it is located in .pixi/env/bin/kiara
. So either adapt your PATH
variable, or do something like:
.pixi/env/bin/kiara operation list
In most cases it's recommended to use a pixi shell though.
Using pre-defined development-related tasks
The included pixi.toml
file includes some useful tasks that help with development:
pixi run pre-commit-check
: runs a set of checks against all filespixi run tests
: runs the unit testspixi run mypy
: run mypy checks
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
File details
Details for the file kiara_plugin_onboarding-0.5.1.tar.gz
.
File metadata
- Download URL: kiara_plugin_onboarding-0.5.1.tar.gz
- Upload date:
- Size: 47.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e84c89a79622caafc2df2a0f191ccff4bb8216fb5ae9e784f11c4ab9fec21ce4 |
|
MD5 | 3f461c0fc3e5eed473b383efb76caf1d |
|
BLAKE2b-256 | 480f279a2151a56f2d390be9fd76277d13469448d95b25b65e9ca3a003b685ab |
File details
Details for the file kiara_plugin.onboarding-0.5.1-py3-none-any.whl
.
File metadata
- Download URL: kiara_plugin.onboarding-0.5.1-py3-none-any.whl
- Upload date:
- Size: 27.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 660d81b80c879b398d3bc72faaba5e1c13a8b36792d4c88ba8615323b6757503 |
|
MD5 | 3b0ec80084528ed8b864a350a321f4c9 |
|
BLAKE2b-256 | 2f132874cdc4e3adec51909a05e1119031231f05036516332ade5be17c56ca5a |