Usage¶
This page outlines the utilities included in this package, this is not necessarily required for kiara development.
Installation¶
To install this package, run (within an activated virtual environment):
```bash
pip install kiara_plugin.develop
# or, when using conda
conda install kiara_plugin.develop
After installation, kiara --help should include the dev subcommand:
> kiara --help
[1m [0m
[1m [0m[1;33mUsage: [0m[1mkiara [[0m[1;36mOPTIONS[0m[1m] [0m[1;36mCOMMAND[0m[1m [[0m[1;36mARGS[0m[1m]...[0m[1m [0m[1m [0m
[1m [0m
[1;3mkiara[0m ia a data-orchestration framework; this is the command-line frontend for it.
[2mFor more information, visit the [0m[1;2;3mkiara[0m[2;3m homepage[0m[2m: https://dharpa.org/kiara.documentation .[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-config[0m [1;32m-cnf[0m [1;33mTEXT[0m [1;36mA[0m kiara config file (or folder containing one named 'kiara.config'). [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-context[0m [1;32m-ctx[0m,[1;32m-c[0m [1;33mTEXT[0m The name of the kiara context to use (or the path to a context file). [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-pipelines[0m [1;32m-p[0m [1;33mTEXT[0m File(s) and folder(s) that contain extra pipeline definitions. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-plugin[0m [1;32m-[0m[1;36mP[0m [1;33mTEXT[0m Ensure the provided plugin package(s) are installed in the virtual environment. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-use[0m[1;36m-background-service[0m [1;32m-b[0m [1;33m [0m Always use the background service (start if not already running). [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-version[0m [1;32m-v[0m [1;33m [0m Show the version of kiara and installed plugins, then exit. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;32m-h[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36mconda [0m[1;36m [0m Conda environment related sub-commands. [2m│[0m
[2m│[0m [1;36mconfig [0m[1;36m [0m Kiara config related sub-commands. [2m│[0m
[2m│[0m [1;36mcontext [0m[1;36m [0m Kiara context related sub-commands. [2m│[0m
[2m│[0m [1;36mdata [0m[1;36m [0m Data-related sub-commands. [2m│[0m
[2m│[0m [1;36mdata-type [0m[1;36m [0m Information about available data types. [2m│[0m
[2m│[0m [1;36mdebug [0m[1;36m [0m Kiara context related sub-commands. [2m│[0m
[2m│[0m [1;36mdev [0m[1;36m [0m Kiara context related sub-commands. [2m│[0m
[2m│[0m [1;36mmodule [0m[1;36m [0m Module-related sub-commands. [2m│[0m
[2m│[0m [1;36moperation [0m[1;36m [0m Operation-related sub-commands. [2m│[0m
[2m│[0m [1;36mpipeline [0m[1;36m [0m Pipeline-related sub-commands. [2m│[0m
[2m│[0m [1;36mrender [0m[1;36m [0m Render an internal kiara item. [2m│[0m
[2m│[0m [1;36mrun [0m[1;36m [0m Run a kiara operation. [2m│[0m
[2m│[0m [1;36mworkflow [0m[1;36m [0m Workflow-related sub-commands. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯[0m
Create new project¶
- create project in Github
- git remote add origin git@github.com:
/ - git push -u origin develop