Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caro401/kiara_plugin.sample_plugin
https://github.com/caro401/kiara_plugin.sample_plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/caro401/kiara_plugin.sample_plugin
- Owner: caro401
- License: mpl-2.0
- Created: 2024-03-12T21:05:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-13T18:10:15.000Z (9 months ago)
- Last Synced: 2024-03-13T23:44:36.691Z (9 months ago)
- Language: Python
- Size: 193 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
[](https://pypi.python.org/pypi/kiara_plugin.sample_plugin/)
[](https://pypi.python.org/pypi/kiara_plugin.sample_plugin/)
[](https://pypi.python.org/pypi/kiara_plugin.sample_plugin/)
[](https://actions-badge.atrox.dev/caro401/kiara_plugin.sample_plugin/goto?ref=develop)
[](https://coveralls.io/github/caro401/kiara_plugin.sample_plugin?branch=develop)
[](https://github.com/ambv/black)
# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (sample-plugin)
sample-plugin
- Documentation: [https://caro401.github.io/kiara_plugin.sample_plugin](https://caro401.github.io/kiara_plugin.sample_plugin)
- Code: [https://github.com/caro401/kiara_plugin.sample_plugin](https://github.com/caro401/kiara_plugin.sample_plugin)
- `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-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 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.