| Name | kiara-plugin.develop JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | None |
| Summary | Development utilities for kiara. |
| upload_time | 2024-12-18 14:01:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MPL-2.0 |
| keywords |
kiara
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.python.org/pypi/kiara_plugin.develop/)
[](https://pypi.python.org/pypi/kiara_plugin.develop/)
[](https://pypi.python.org/pypi/kiara_plugin.develop/)
[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.develop/goto?ref=develop)
[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.develop?branch=develop)
[](https://github.com/ambv/black)
# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (develop)
Development utilities for kiara.
- Documentation: [https://DHARPA-Project.github.io/kiara_plugin.develop](https://DHARPA-Project.github.io/kiara_plugin.develop)
- Code: [https://github.com/DHARPA-Project/kiara_plugin.develop](https://github.com/DHARPA-Project/kiara_plugin.develop)
- `kiara`: [https://dharpa.org/kiara.documentation](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](https://github.com/prefix-dev/pixi). Check out [their install instructions](https://github.com/prefix-dev/pixi#installation).
Once you have `pixi` installed, you need to initialize the environment once:
```
pixi run install-dev-dependencies
```
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 `pyproject.toml` file includes some useful tasks that help with development:
- `pixi run pre-commit-check`: runs a set of checks against all files
- `pixi run tests`: runs the unit tests
- `pixi run mypy`: run mypy checks
## Copyright & license
This project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.
Raw data
{
"_id": null,
"home_page": null,
"name": "kiara-plugin.develop",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "kiara",
"author": null,
"author_email": "Markus Binsteiner <markus@frkl.io>",
"download_url": "https://files.pythonhosted.org/packages/0d/c9/5a60069a3fd73e7adfffca0b6ef681743dce9e707c7288c568403806b60d/kiara_plugin_develop-0.5.3.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/kiara_plugin.develop/)\n[](https://pypi.python.org/pypi/kiara_plugin.develop/)\n[](https://pypi.python.org/pypi/kiara_plugin.develop/)\n[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.develop/goto?ref=develop)\n[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.develop?branch=develop)\n[](https://github.com/ambv/black)\n\n# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (develop)\n\nDevelopment utilities for kiara.\n\n - Documentation: [https://DHARPA-Project.github.io/kiara_plugin.develop](https://DHARPA-Project.github.io/kiara_plugin.develop)\n - Code: [https://github.com/DHARPA-Project/kiara_plugin.develop](https://github.com/DHARPA-Project/kiara_plugin.develop)\n - `kiara`: [https://dharpa.org/kiara.documentation](https://dharpa.org/kiara.documentation)\n\n## Description\n\nTODO\n\n## Development\n\n### Requirements\n\n- Python (version >= 3.8)\n- pip, virtualenv\n- git\n- make (on Linux / Mac OS X -- optional)\n\n\n### Prepare development environment\n\nIf you only want to work on the modules, and not the core *Kiara* codebase, follow the instructions below. Otherwise, please\ncheck the notes on how to setup a *Kiara* development environment under (TODO).\n\n#### Using `pixi` (recommended)\n\nThe recommended way to setup a development environment is to use [pixi](https://github.com/prefix-dev/pixi). Check out [their install instructions](https://github.com/prefix-dev/pixi#installation).\n\nOnce you have `pixi` installed, you need to initialize the environment once:\n\n```\npixi run install-dev-dependencies\n```\n\nYou also need to do this whenever a depdendency of this plugin is updated (for example the core `kiara` package).\n\nOnce that is done, you can enter the environment with:\n\n```\npixi shell\n```\n\nThis 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:\n\n```\nkiara --version\n# or\nkiara operation list\n# or\n...\n...\n```\n\nOnce you are finished with your development session, you can exit the sub-shell as you would normally do in such cases:\n\n```\nexit\n```\n\nAlternatively, 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:\n\n```\n.pixi/env/bin/kiara operation list\n```\n\nIn most cases it's recommended to use a pixi shell though.\n\n\n### Using pre-defined development-related tasks\n\nThe included `pyproject.toml` file includes some useful tasks that help with development:\n\n- `pixi run pre-commit-check`: runs a set of checks against all files\n- `pixi run tests`: runs the unit tests\n- `pixi run mypy`: run mypy checks\n\n## Copyright & license\n\nThis project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Development utilities for kiara.",
"version": "0.5.3",
"project_urls": {
"documentation": "https://DHARPA-Project.github.io/kiara_plugin.develop",
"homepage": "https://github.com/DHARPA-Project/kiara_plugin.develop",
"repository": "https://github.com/DHARPA-Project/kiara_plugin.develop"
},
"split_keywords": [
"kiara"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "292f182d06f6e06e35d0bc2be34c36f6b018985f0f4bea12c1b117159a05fbee",
"md5": "a3138d9ac1e83e426667de3ea2f8f686",
"sha256": "ce5738f256a3d5ef7696450f47b1e6bc68751682cc1f14f19c51a855cb4a0c51"
},
"downloads": -1,
"filename": "kiara_plugin.develop-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3138d9ac1e83e426667de3ea2f8f686",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 48049,
"upload_time": "2024-12-18T14:01:32",
"upload_time_iso_8601": "2024-12-18T14:01:32.074326Z",
"url": "https://files.pythonhosted.org/packages/29/2f/182d06f6e06e35d0bc2be34c36f6b018985f0f4bea12c1b117159a05fbee/kiara_plugin.develop-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0dc95a60069a3fd73e7adfffca0b6ef681743dce9e707c7288c568403806b60d",
"md5": "c0584cd4526ea2f31efcdcc8c4440246",
"sha256": "2f1db061eaf3e53d7307fcbf7f6777f2f75fa43e50fc354a9dd28063c40d4fa5"
},
"downloads": -1,
"filename": "kiara_plugin_develop-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "c0584cd4526ea2f31efcdcc8c4440246",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 96180,
"upload_time": "2024-12-18T14:01:33",
"upload_time_iso_8601": "2024-12-18T14:01:33.520245Z",
"url": "https://files.pythonhosted.org/packages/0d/c9/5a60069a3fd73e7adfffca0b6ef681743dce9e707c7288c568403806b60d/kiara_plugin_develop-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 14:01:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DHARPA-Project",
"github_project": "kiara_plugin.develop",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kiara-plugin.develop"
}
