marops-config

Name	marops-config JSON
Version	2.10.0 JSON
	download
home_page	https://github.com/Greenroom-Robotics/marops
Summary	A library for reading / writing MarOps config files
upload_time	2024-04-08 07:13:41
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/de/11/161f20f16b17eb83d23522a6a0679696401fc2e2d85995a80af86b55ab25/marops_config-2.10.0.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": "2.10.0",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/marops"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ab905eeeb83188cdee9193c4e751dd53c9a94e023482a7f00f45d81b22bc93b",
                "md5": "d0b44871c9bc2a23f7d56788fb06480e",
                "sha256": "f3d2ed372b800cbf881145e0ef3bef3172d15267d0395354f495ccc87f4b49c9"
            },
            "downloads": -1,
            "filename": "marops_config-2.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d0b44871c9bc2a23f7d56788fb06480e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4061,
            "upload_time": "2024-04-08T07:13:40",
            "upload_time_iso_8601": "2024-04-08T07:13:40.234701Z",
            "url": "https://files.pythonhosted.org/packages/3a/b9/05eeeb83188cdee9193c4e751dd53c9a94e023482a7f00f45d81b22bc93b/marops_config-2.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de11161f20f16b17eb83d23522a6a0679696401fc2e2d85995a80af86b55ab25",
                "md5": "b74bfc727c83f8c4585717f896f57a3b",
                "sha256": "9fb17383de8c8805fac85b1b8cc2743f21c5a91e3ecc2acda7c2bf467a4d0de5"
            },
            "downloads": -1,
            "filename": "marops_config-2.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b74bfc727c83f8c4585717f896f57a3b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3099,
            "upload_time": "2024-04-08T07:13:41",
            "upload_time_iso_8601": "2024-04-08T07:13:41.761335Z",
            "url": "https://files.pythonhosted.org/packages/de/11/161f20f16b17eb83d23522a6a0679696401fc2e2d85995a80af86b55ab25/marops_config-2.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-08 07:13:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "marops",
    "github_not_found": true,
    "lcname": "marops-config"
}