lookout-config

Name	lookout-config JSON
Version	1.2.2 JSON
	download
home_page	https://github.com/Greenroom-Robotics/lookout
Summary	A library for reading / writing Lookout config files
upload_time	2024-04-15 23:00:30
maintainer	David Revay
docs_url	None
author	Greenroom Robotics
requires_python	None
license	Copyright (C) 2023, Greenroom Robotics
keywords	colcon
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Lookout Config

Lookout Config is used to load config stored inside the `~/.config/greenroom` folder.

## Install

* `pip install -e ./libs/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/f4/40/fef716d54add0ea63efb077b562456c471d2e9de5f59997dc1de9a79b3ba/lookout_config-1.2.2.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 ./libs/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.2.2",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/lookout"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3a325724f323d44001284f79c16407f0b3aadc73c6081d762d7a6ab5d6ea7fa",
                "md5": "1dd1d3a0adb47948bfd797c8fd0afc77",
                "sha256": "cee562ef6137ee6b8e7a5382455d70b728ba37ef1723721a5153f0ca855e143b"
            },
            "downloads": -1,
            "filename": "lookout_config-1.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1dd1d3a0adb47948bfd797c8fd0afc77",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7115,
            "upload_time": "2024-04-15T23:00:28",
            "upload_time_iso_8601": "2024-04-15T23:00:28.555678Z",
            "url": "https://files.pythonhosted.org/packages/f3/a3/25724f323d44001284f79c16407f0b3aadc73c6081d762d7a6ab5d6ea7fa/lookout_config-1.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f440fef716d54add0ea63efb077b562456c471d2e9de5f59997dc1de9a79b3ba",
                "md5": "7f790b01eaab41c6406ae788f32c1dbc",
                "sha256": "dddeda28305c5d94b417ffde9f856b0ccb6def7f8d6fbdfb8993a7044e042d88"
            },
            "downloads": -1,
            "filename": "lookout_config-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7f790b01eaab41c6406ae788f32c1dbc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6176,
            "upload_time": "2024-04-15T23:00:30",
            "upload_time_iso_8601": "2024-04-15T23:00:30.186686Z",
            "url": "https://files.pythonhosted.org/packages/f4/40/fef716d54add0ea63efb077b562456c471d2e9de5f59997dc1de9a79b3ba/lookout_config-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 23:00:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "lookout",
    "github_not_found": true,
    "lcname": "lookout-config"
}