# Lookout Config
Lookout Config is used to load config stored inside the `~/.config/greenroom` folder.
## Install
* `pip install -e ./packages/lookout_config`
* or...
* `pip install lookout_config` (Public on [PyPi](https://pypi.org/project/lookout-config/))
## Usage
### Reading config
```python
from lookout_config import read
config = read()
```
### Writing config
```python
from lookout_config import write, LookoutConfig
config = LookoutConfig()
write(config)
```
### Generating schemas
After changing the dataclasses, you can generate the schemas with:
```bash
python3 -m lookout_config.generate_schemas
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Greenroom-Robotics/lookout",
"name": "lookout-config",
"maintainer": "David Revay",
"docs_url": null,
"requires_python": null,
"maintainer_email": "david.revay@greenroomrobotics.com",
"keywords": "colcon",
"author": "Greenroom Robotics",
"author_email": "team@greenroomrobotics.com",
"download_url": "https://files.pythonhosted.org/packages/22/63/be20eab5df87680b0d3f6f7da9afc02bf0b467b134dedc3456bc404ed968/lookout_config-1.14.1.tar.gz",
"platform": null,
"description": "# Lookout Config\n\nLookout Config is used to load config stored inside the `~/.config/greenroom` folder.\n\n## Install\n\n* `pip install -e ./packages/lookout_config`\n* or...\n* `pip install lookout_config` (Public on [PyPi](https://pypi.org/project/lookout-config/))\n\n## Usage\n\n### Reading config\n\n```python\nfrom lookout_config import read\n\nconfig = read()\n```\n\n### Writing config\n\n```python\nfrom lookout_config import write, LookoutConfig\n\nconfig = LookoutConfig()\n\nwrite(config)\n\n```\n\n### Generating schemas\n\nAfter changing the dataclasses, you can generate the schemas with:\n\n```bash\npython3 -m lookout_config.generate_schemas\n```\n",
"bugtrack_url": null,
"license": "Copyright (C) 2023, Greenroom Robotics",
"summary": "A library for reading / writing Lookout config files",
"version": "1.14.1",
"project_urls": {
"Homepage": "https://github.com/Greenroom-Robotics/lookout"
},
"split_keywords": [
"colcon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59af673a7a89e0ad07dcf4b6dc26fa6d3bca87d39da019f7a6b87d958f6491ab",
"md5": "c4f3ec0a0f80e2a97ea5c78ee1ae3457",
"sha256": "bf6d432f74c1d0e882b19568be0712ba54e06b8548f15fc3974b3317a962f2bb"
},
"downloads": -1,
"filename": "lookout_config-1.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4f3ec0a0f80e2a97ea5c78ee1ae3457",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9547,
"upload_time": "2024-12-17T22:24:33",
"upload_time_iso_8601": "2024-12-17T22:24:33.071294Z",
"url": "https://files.pythonhosted.org/packages/59/af/673a7a89e0ad07dcf4b6dc26fa6d3bca87d39da019f7a6b87d958f6491ab/lookout_config-1.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2263be20eab5df87680b0d3f6f7da9afc02bf0b467b134dedc3456bc404ed968",
"md5": "cedc78add5b727cb0db5c1373164e5a9",
"sha256": "a19b5fbfcbe590c1670aa9407fbe7d24255184aad6c8de74fcde35d169592f70"
},
"downloads": -1,
"filename": "lookout_config-1.14.1.tar.gz",
"has_sig": false,
"md5_digest": "cedc78add5b727cb0db5c1373164e5a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8006,
"upload_time": "2024-12-17T22:24:34",
"upload_time_iso_8601": "2024-12-17T22:24:34.247835Z",
"url": "https://files.pythonhosted.org/packages/22/63/be20eab5df87680b0d3f6f7da9afc02bf0b467b134dedc3456bc404ed968/lookout_config-1.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 22:24:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Greenroom-Robotics",
"github_project": "lookout",
"github_not_found": true,
"lcname": "lookout-config"
}
JSON
