| Name | kiara-plugin.jupyter JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | |
| Summary | Jupyter integration for kiara |
| upload_time | 2023-12-19 10:32:00 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| 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.jupyter/)
[](https://pypi.python.org/pypi/kiara_plugin.jupyter/)
[](https://pypi.python.org/pypi/kiara_plugin.jupyter/)
[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.jupyter/goto?ref=develop)
[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.jupyter?branch=develop)
[](https://github.com/ambv/black)
# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (jupyter)
Jupyter integration for kiara
- Documentation: [https://DHARPA-Project.github.io/kiara_plugin.jupyter](https://DHARPA-Project.github.io/kiara_plugin.jupyter)
- Code: [https://github.com/DHARPA-Project/kiara_plugin.jupyter](https://github.com/DHARPA-Project/kiara_plugin.jupyter)
- `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).
#### Linux & Mac OS X (using make)
For *NIX-like operating system, setting up a development environment is relatively easy:
```console
git clone https://github.com/DHARPA-Project/kiara_plugin.jupyter.git
cd kiara_plugin.jupyter
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)](https://docs.anaconda.com/anaconda/install/index.html), 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:
```console
# make sure your virtual env is activated!!!
git clone https://github.com/DHARPA-Project/kiara_plugin.jupyter.git
cd kiara_plugin.jupyter
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:
```console
kiara run jupyter_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:
```console
cd path/to/kiara_plugin.jupyter
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 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``.
### Running tests
``` console
> make test
# or
> make coverage
```
## 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": "",
"name": "kiara-plugin.jupyter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "kiara",
"author": "",
"author_email": "Markus Binsteiner <markus@frkl.io>",
"download_url": "https://files.pythonhosted.org/packages/90/e5/c598cd03f011e2670c7b181e25484eb7518cd6cf8efff0b3f83e50916a18/kiara_plugin.jupyter-0.5.0.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/kiara_plugin.jupyter/)\n[](https://pypi.python.org/pypi/kiara_plugin.jupyter/)\n[](https://pypi.python.org/pypi/kiara_plugin.jupyter/)\n[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.jupyter/goto?ref=develop)\n[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.jupyter?branch=develop)\n[](https://github.com/ambv/black)\n\n# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (jupyter)\n\nJupyter integration for kiara\n\n - Documentation: [https://DHARPA-Project.github.io/kiara_plugin.jupyter](https://DHARPA-Project.github.io/kiara_plugin.jupyter)\n - Code: [https://github.com/DHARPA-Project/kiara_plugin.jupyter](https://github.com/DHARPA-Project/kiara_plugin.jupyter)\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#### Linux & Mac OS X (using make)\n\nFor *NIX-like operating system, setting up a development environment is relatively easy:\n\n```console\ngit clone https://github.com/DHARPA-Project/kiara_plugin.jupyter.git\ncd kiara_plugin.jupyter\npython3 -m venv .venv\nsource .venv/bin/activate\nmake init\n```\n\n#### Windows (or manual pip install)\n\nIt'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.\nOne simple way is to install the [Anaconda (individual edition)](https://docs.anaconda.com/anaconda/install/index.html), 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.\n\nOnce that is done, `cd` into a directory where you want this project folder to live, and do:\n\n```console\n# make sure your virtual env is activated!!!\ngit clone https://github.com/DHARPA-Project/kiara_plugin.jupyter.git\ncd kiara_plugin.jupyter\npip install --extra-index-url https://pypi.fury.io/dharpa/ -U -e .[all_dev]\n```\n\n#### Try it out\n\nAfter this is done, you should be able to run the included example module via:\n\n```console\nkiara run jupyter_example text_1=\"xxx\" text_2=\"yyy\"\n...\n...\n```\n\n### Re-activate the development environment\n\nThe 'prepare' step from above only has to be done once. After that, to re-enable your virtual environment,\nyou'll need to navigate to the directory again (wherever that is, in your case), and run the ``source`` command from before again:\n\n```console\ncd path/to/kiara_plugin.jupyter\nsource .venv/bin/activate # if it isn't activated already, for example by the Anaconda navigator\nkiara --help # or whatever, point is, kiara should be available for you now,\n```\n\n### ``make`` targets (Linux & Mac OS X)\n\n- ``init``: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)\n- ``update-dependencies``: update development dependencies (mainly the core ``kiara`` package from git)\n- ``flake``: run *flake8* tests\n- ``mypy``: run mypy tests\n- ``test``: run unit tests\n- ``docs``: create static documentation pages (under ``build/site``)\n- ``serve-docs``: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentation\n- ``clean``: clean build directories\n\nFor details (and other, minor targets), check the ``Makefile``.\n\n\n### Running tests\n\n``` console\n> make test\n# or\n> make coverage\n```\n\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": "Jupyter integration for kiara",
"version": "0.5.0",
"project_urls": {
"documentation": "https://DHARPA-Project.github.io/kiara_plugin.jupyter",
"homepage": "https://github.com/DHARPA-Project/kiara_plugin.jupyter",
"repository": "https://github.com/DHARPA-Project/kiara_plugin.jupyter"
},
"split_keywords": [
"kiara"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85c635b0c6a83139ab7b52d3fae906c77d81634ffae783511e28f408097cd243",
"md5": "06e8256e3e44a3578e4388ec374905fa",
"sha256": "1cc2ba56fd7ce06532585c6b81d95265d6c48c2a356d92a223049651065521bd"
},
"downloads": -1,
"filename": "kiara_plugin.jupyter-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06e8256e3e44a3578e4388ec374905fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23954,
"upload_time": "2023-12-19T10:31:58",
"upload_time_iso_8601": "2023-12-19T10:31:58.362900Z",
"url": "https://files.pythonhosted.org/packages/85/c6/35b0c6a83139ab7b52d3fae906c77d81634ffae783511e28f408097cd243/kiara_plugin.jupyter-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90e5c598cd03f011e2670c7b181e25484eb7518cd6cf8efff0b3f83e50916a18",
"md5": "0a5a0bb5dd891de553516aef3a98ca47",
"sha256": "6fbd0cdc0fdc7b17dbaabaa16a0110576c649e498f19597147c795bebc5f8371"
},
"downloads": -1,
"filename": "kiara_plugin.jupyter-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "0a5a0bb5dd891de553516aef3a98ca47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60484,
"upload_time": "2023-12-19T10:32:00",
"upload_time_iso_8601": "2023-12-19T10:32:00.415494Z",
"url": "https://files.pythonhosted.org/packages/90/e5/c598cd03f011e2670c7b181e25484eb7518cd6cf8efff0b3f83e50916a18/kiara_plugin.jupyter-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-19 10:32:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DHARPA-Project",
"github_project": "kiara_plugin.jupyter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kiara-plugin.jupyter"
}
