marops-config

Name	marops-config JSON
Version	3.6.4 JSON
	download
home_page	https://github.com/Greenroom-Robotics/marops
Summary	A library for reading / writing MarOps config files
upload_time	2024-12-13 07:43:35
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.

            # MarOps Config

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

## Install

* `pip install -e ./libs/marops_config`

## Usage

### Reading config

```python
from marops_config import read

config = read()
```

### Writing config

```python
from marops_config import write, MarOpsConfig

config = MarOpsConfig()

write(config)

```

### Generating schemas

After changing the dataclasses, you can generate the schemas with:

```bash
python3 -m marops_config.generate_schemas
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Greenroom-Robotics/marops",
    "name": "marops-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/75/cf/bd45210fe86e5c483d6923fc44acf5a7e75900f9777fab9d39470f103972/marops_config-3.6.4.tar.gz",
    "platform": null,
    "description": "# MarOps Config\n\nMarOps Config is used to load config stored inside the `~/.config/greenroom` folder.\n\n## Install\n\n* `pip install -e ./libs/marops_config`\n\n## Usage\n\n### Reading config\n\n```python\nfrom marops_config import read\n\nconfig = read()\n```\n\n### Writing config\n\n```python\nfrom marops_config import write, MarOpsConfig\n\nconfig = MarOpsConfig()\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 marops_config.generate_schemas\n```\n",
    "bugtrack_url": null,
    "license": "Copyright (C) 2023, Greenroom Robotics",
    "summary": "A library for reading / writing MarOps config files",
    "version": "3.6.4",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/marops"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c9d43376bc77a201c42675a98a229074ba4caf5512d34d8ed46596574cb9d6a",
                "md5": "bc2c0f0c2451f65131e417f40d90fb45",
                "sha256": "4c8150f8ad1b2ecc2ccddb51a2025d3019631f1309b0be363fd55e4eecdfe938"
            },
            "downloads": -1,
            "filename": "marops_config-3.6.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bc2c0f0c2451f65131e417f40d90fb45",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4082,
            "upload_time": "2024-12-13T07:43:33",
            "upload_time_iso_8601": "2024-12-13T07:43:33.620616Z",
            "url": "https://files.pythonhosted.org/packages/6c/9d/43376bc77a201c42675a98a229074ba4caf5512d34d8ed46596574cb9d6a/marops_config-3.6.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "75cfbd45210fe86e5c483d6923fc44acf5a7e75900f9777fab9d39470f103972",
                "md5": "918f2224b8853d565ae38203a5e93cbc",
                "sha256": "fd6de50debd35d137d048402179bfbac6edfd4f480ca7f74bc2364b03a3862c8"
            },
            "downloads": -1,
            "filename": "marops_config-3.6.4.tar.gz",
            "has_sig": false,
            "md5_digest": "918f2224b8853d565ae38203a5e93cbc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3105,
            "upload_time": "2024-12-13T07:43:35",
            "upload_time_iso_8601": "2024-12-13T07:43:35.744763Z",
            "url": "https://files.pythonhosted.org/packages/75/cf/bd45210fe86e5c483d6923fc44acf5a7e75900f9777fab9d39470f103972/marops_config-3.6.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-13 07:43:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "marops",
    "github_not_found": true,
    "lcname": "marops-config"
}