# kloch
[](https://knotsanimation.github.io/kloch/)
> [!WARNING]
> Despite being public, this repository is still in development stage and
> have not been tested extensively yet.
``kloch`` _/klˈoʃ/_ is a configuration system for launching software.
Configurations are yaml files referred as "environment profile" which specify
the parameters for one or multiple pre-defined _launchers_.
_Launchers_ are internally defined python objects that specify how to execute
a combinations of options and (optional) command.
In a very abstract way, `kloch` is a system that:
- serialize the arguments passed to a pre-defined function as yaml files.
- execute that function by unserializing the parameters provided at runtime.
`kloch` was initially designed as the environment manager layer when used with
the [rez](https://rez.readthedocs.io) package manager.
## features
- offer a CLI and a public python API
- custom config format for environment profiles:
- inheritance
- inheritance merging rules with token system
- arbitrary profile locations with flexible configuration
- plugin system for launchers
## programming distinctions
- robust logging.
- good amount of unittesting
- good documentation with a lot of doc created at code level
- python 3.7+ support (EOL was in June 2023).
- PyYAML as only mandatory external python dependency.
- flexible "meta" configuration from environment variable or config file.
- clear public and private API
## quick-start
```shell
pip install kloch
kloch --help
# or:
python -m kloch --help
```
## documentation
Check the detailed documentation at https://knotsanimation.github.io/kloch/
Raw data
{
"_id": null,
"home_page": null,
"name": "kloch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "environment, kloch, packaging, managing",
"author": "Liam Collod",
"author_email": "monsieurlixm@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1d/f6/3f083e82288b777a7dc52f20691f026007f237cde3bd143f421c740a4ce3/kloch-0.12.0.tar.gz",
"platform": null,
"description": "# kloch\n\n[](https://knotsanimation.github.io/kloch/)\n\n\n\n> [!WARNING]\n> Despite being public, this repository is still in development stage and\n> have not been tested extensively yet.\n\n\n\n``kloch`` _/kl\u02c8o\u0283/_ is a configuration system for launching software. \nConfigurations are yaml files referred as \"environment profile\" which specify\nthe parameters for one or multiple pre-defined _launchers_.\n\n_Launchers_ are internally defined python objects that specify how to execute\na combinations of options and (optional) command.\n\nIn a very abstract way, `kloch` is a system that:\n- serialize the arguments passed to a pre-defined function as yaml files.\n- execute that function by unserializing the parameters provided at runtime.\n\n`kloch` was initially designed as the environment manager layer when used with\nthe [rez](https://rez.readthedocs.io) package manager.\n\n## features\n\n- offer a CLI and a public python API\n- custom config format for environment profiles:\n - inheritance\n - inheritance merging rules with token system\n- arbitrary profile locations with flexible configuration\n- plugin system for launchers\n\n## programming distinctions\n\n- robust logging.\n- good amount of unittesting\n- good documentation with a lot of doc created at code level\n- python 3.7+ support (EOL was in June 2023).\n- PyYAML as only mandatory external python dependency.\n- flexible \"meta\" configuration from environment variable or config file.\n- clear public and private API\n\n## quick-start\n\n```shell\npip install kloch\nkloch --help\n# or:\npython -m kloch --help \n```\n\n\n## documentation\n\nCheck the detailed documentation at https://knotsanimation.github.io/kloch/\n\n",
"bugtrack_url": null,
"license": "LICENSE.txt",
"summary": "Environment Manager CLI wrapping package managers calls as serialized config file",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://knotsanimation.github.io/kloch/",
"github": "https://github.com/knotsanimation/kloch",
"homepage": "https://github.com/knotsanimation/kloch",
"issues": "https://github.com/knotsanimation/kloch/issues",
"releasenotes": "https://knotsanimation.github.io/kloch/changelog.html"
},
"split_keywords": [
"environment",
" kloch",
" packaging",
" managing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14f93a6e4d04aeaba0b93d5ce50c9a630c338743857dc355c72407aff31ceec6",
"md5": "8df67203c26ecd713ab44c2c75996595",
"sha256": "ea6408611ef3ac789d0e70354726de17a000e8f1b2ecd5c53c063f20218dcc3a"
},
"downloads": -1,
"filename": "kloch-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8df67203c26ecd713ab44c2c75996595",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 36450,
"upload_time": "2024-11-15T19:08:23",
"upload_time_iso_8601": "2024-11-15T19:08:23.621178Z",
"url": "https://files.pythonhosted.org/packages/14/f9/3a6e4d04aeaba0b93d5ce50c9a630c338743857dc355c72407aff31ceec6/kloch-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1df63f083e82288b777a7dc52f20691f026007f237cde3bd143f421c740a4ce3",
"md5": "5f1c4496ff6244b8a2e0e5842006f461",
"sha256": "fe8a9debb6740408fb276f735cbadb88c122f65070a6c62de88ad2f68be9fdbd"
},
"downloads": -1,
"filename": "kloch-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "5f1c4496ff6244b8a2e0e5842006f461",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 27368,
"upload_time": "2024-11-15T19:08:25",
"upload_time_iso_8601": "2024-11-15T19:08:25.228387Z",
"url": "https://files.pythonhosted.org/packages/1d/f6/3f083e82288b777a7dc52f20691f026007f237cde3bd143f421c740a4ce3/kloch-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 19:08:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "knotsanimation",
"github_project": "kloch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kloch"
}
JSON
