marops-config

Name	marops-config JSON
Version	3.7.1 JSON
	download
home_page	https://github.com/Greenroom-Robotics/marops
Summary	A library for reading / writing MarOps config files
upload_time	2025-02-14 06:11:11
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/7e/98/196cff46cc8baf0e7367bcd2a180cd907aff7b2a19333200e3eb1a3bfdd2/marops_config-3.7.1.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.7.1",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/marops"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e6d0c01eb66a4f2cbbfa0ef9c805897785a4e79d0bf8c6b62ef5762e44c0b6f8",
                "md5": "6d45f2ebad4aa2cb0f38e80749ee54ea",
                "sha256": "4add60d73c1fb3db926289482ea34e7b3c545b73d9278a2ef25ce63998046930"
            },
            "downloads": -1,
            "filename": "marops_config-3.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6d45f2ebad4aa2cb0f38e80749ee54ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4081,
            "upload_time": "2025-02-14T06:11:09",
            "upload_time_iso_8601": "2025-02-14T06:11:09.946206Z",
            "url": "https://files.pythonhosted.org/packages/e6/d0/c01eb66a4f2cbbfa0ef9c805897785a4e79d0bf8c6b62ef5762e44c0b6f8/marops_config-3.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7e98196cff46cc8baf0e7367bcd2a180cd907aff7b2a19333200e3eb1a3bfdd2",
                "md5": "fe2f967b261e535de583be1d39898929",
                "sha256": "5609465e6865344aac874258bd81ac0f0de77b7fffaa07df549aacb7be073a65"
            },
            "downloads": -1,
            "filename": "marops_config-3.7.1.tar.gz",
            "has_sig": false,
            "md5_digest": "fe2f967b261e535de583be1d39898929",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3125,
            "upload_time": "2025-02-14T06:11:11",
            "upload_time_iso_8601": "2025-02-14T06:11:11.633729Z",
            "url": "https://files.pythonhosted.org/packages/7e/98/196cff46cc8baf0e7367bcd2a180cd907aff7b2a19333200e3eb1a3bfdd2/marops_config-3.7.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-14 06:11:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "marops",
    "github_not_found": true,
    "lcname": "marops-config"
}