# VR.Configuration
VR.Configuration is a configuration management system for Python projects.
Assuming your configuration to use YAML configuration files,
you can define their structure and type by Python schema files.
That way, this project
enables easy configuration with minimal syntax while
providing software assistance for using configurations.
## Features
- Python-based typed schema definition
- Autocompletion within IDEs
- Semi-automatic parsing of yaml files
- Extensibility for custom types
- Reconfiguration at runtime
## Problem Statement
Oftentimes, we build systems from configurable parts.
Ideally, the configuration would be structured like our system.
Therefore, we need a structuring configuration system.
## Approach
The de-facto standard configuration language is currently YAML.
The structure with the least syntax in Python are classes.
So, we choose YAML as configuration syntax and Python classes as parsing target.
## Mental Model
As shown on the left,
a composed systems without a configuration management system
might end up with different means of configuration.
As shown on the right,
a composed system using this package
can use a single means of configuration for all its components.
This helps
with increasing development velocity
because all components benefit from the features
of the configuration management system.
## Status
[](https://gitlab.com/dfki/fb/ni/ol/iml/vr/vr.configuration/-/pipelines/latest)
[](https://gitlab.com/dfki/fb/ni/ol/iml/vr/vr.configuration/-/jobs)
[](https://pypi.org/project/vr-configuration/)
[](https://pypi.org/project/vr-configuration/#history)
[](https://pypi.org/project/vr-configuration/)
[](https://pypi.org/project/vr-configuration/#files)
[](https://pypi.org/project/vr-configuration/)
## License
This package is not licensed. Therefore, it can only be used in the DFKI.
## Usage
This package originates from and is being used in production
at the [VR.Backend](https://git.ni.dfki.de/iml/vr/vr.backend) project.
However,
the VR.Backend project is currently internal to the DFKI.
## Demo
This package enables parsing configuration files according to a schema:
```python
class Config:
greeting: str
greetee: str
Config: type = parse_config(
config_file_path='config.yaml',
)
```
## Tutorial
For more detailed instructions on using this project,
see the [tutorial](README_BASIC.md).
## Development
For development and maintenance of this project,
see the [development documentation](README_DEVELOPERS.md).
## Documentation
For more complete documentation,
see our [dedicated documentation pages](https://dfki.gitlab.io/fb/ni/ol/iml/vr/vr.configuration/).
## Support
Please refer to the issue tracker for any inquiry.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/dfki/ra/ni/ol/iml/vr/vr.configuration/",
"name": "vr-configuration",
"maintainer": "Bengt L\u00fcers",
"docs_url": null,
"requires_python": "",
"maintainer_email": "bengt.lueers@gmail.com",
"keywords": "",
"author": "Bengt L\u00fcers",
"author_email": "bengt.lueers@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/52/b3/3455a99577bf869498720a92e74744df6c4efae25a5dd71254c2bee204f0/vr_configuration-1.1.13.tar.gz",
"platform": null,
"description": "# VR.Configuration\n\nVR.Configuration is a configuration management system for Python projects.\nAssuming your configuration to use YAML configuration files,\n you can define their structure and type by Python schema files.\nThat way, this project\n enables easy configuration with minimal syntax while\n providing software assistance for using configurations.\n\n## Features\n\n- Python-based typed schema definition\n- Autocompletion within IDEs\n- Semi-automatic parsing of yaml files\n- Extensibility for custom types\n- Reconfiguration at runtime\n\n## Problem Statement\n\nOftentimes, we build systems from configurable parts.\nIdeally, the configuration would be structured like our system.\nTherefore, we need a structuring configuration system.\n\n## Approach\n\nThe de-facto standard configuration language is currently YAML.\nThe structure with the least syntax in Python are classes.\nSo, we choose YAML as configuration syntax and Python classes as parsing target.\n\n## Mental Model\n\n\n\nAs shown on the left,\n a composed systems without a configuration management system\n might end up with different means of configuration.\nAs shown on the right,\n a composed system using this package\n can use a single means of configuration for all its components.\nThis helps\n with increasing development velocity\n because all components benefit from the features\n of the configuration management system.\n\n## Status\n\n[](https://gitlab.com/dfki/fb/ni/ol/iml/vr/vr.configuration/-/pipelines/latest)\n \n[](https://gitlab.com/dfki/fb/ni/ol/iml/vr/vr.configuration/-/jobs)\n \n[](https://pypi.org/project/vr-configuration/)\n \n[](https://pypi.org/project/vr-configuration/#history)\n \n[](https://pypi.org/project/vr-configuration/)\n \n[](https://pypi.org/project/vr-configuration/#files)\n \n[](https://pypi.org/project/vr-configuration/)\n\n## License\n\nThis package is not licensed. Therefore, it can only be used in the DFKI.\n\n## Usage\n\nThis package originates from and is being used in production\n at the [VR.Backend](https://git.ni.dfki.de/iml/vr/vr.backend) project.\nHowever,\n the VR.Backend project is currently internal to the DFKI.\n\n## Demo\n\nThis package enables parsing configuration files according to a schema:\n\n```python\nclass Config:\n greeting: str\n greetee: str\n\n\nConfig: type = parse_config(\n config_file_path='config.yaml',\n)\n```\n\n## Tutorial\n\nFor more detailed instructions on using this project,\n see the [tutorial](README_BASIC.md).\n\n## Development\n\nFor development and maintenance of this project,\n see the [development documentation](README_DEVELOPERS.md).\n\n## Documentation\n\nFor more complete documentation,\n see our [dedicated documentation pages](https://dfki.gitlab.io/fb/ni/ol/iml/vr/vr.configuration/).\n\n## Support\n\nPlease refer to the issue tracker for any inquiry.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Configuration management system for Python projects.",
"version": "1.1.13",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a6427271eebb25b0528e726d9494dec4",
"sha256": "5f796629b75d44ec56b4c8cfd77400290168b5a3267dab7ca6bfe75b39f1c24e"
},
"downloads": -1,
"filename": "vr_configuration-1.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6427271eebb25b0528e726d9494dec4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14944,
"upload_time": "2022-06-23T20:57:30",
"upload_time_iso_8601": "2022-06-23T20:57:30.168890Z",
"url": "https://files.pythonhosted.org/packages/5a/09/c6834ddd8cfeaddb09eb48c93cea072eabf7746a56f1a2dee1f6bda3c539/vr_configuration-1.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "90e0a1887155d0236d6d8b791c8afe3d",
"sha256": "25c41e3c3b1112e3c20164b97feba885ee7e677523fbd38c984bd06f388b5147"
},
"downloads": -1,
"filename": "vr_configuration-1.1.13.tar.gz",
"has_sig": false,
"md5_digest": "90e0a1887155d0236d6d8b791c8afe3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9275,
"upload_time": "2022-06-23T20:57:31",
"upload_time_iso_8601": "2022-06-23T20:57:31.919603Z",
"url": "https://files.pythonhosted.org/packages/52/b3/3455a99577bf869498720a92e74744df6c4efae25a5dd71254c2bee204f0/vr_configuration-1.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-23 20:57:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "vr-configuration"
}
JSON