missim-config

Name	missim-config JSON
Version	1.18.0 JSON
	download
home_page	https://github.com/Greenroom-Robotics/missim
Summary	A library for reading / writing Missim config files
upload_time	2024-12-15 21:52:49
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.

            # Missim Config

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

## Install

* `pip install -e ./packages/missim_config`

## Usage

### Reading config

```python
from missim_config import read

config = read()
```

### Writing config

```python
from missim_config import write, MissimConfig

config = MissimConfig()

write(config)

```

### Generating schemas

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

```bash
python3 -m missim_config.generate_schemas
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Greenroom-Robotics/missim",
    "name": "missim-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/ff/96/6d6b2528c44899fbb0ace85b8fc1cc6ce706c8ccd23286e55ffc5bdad275/missim_config-1.18.0.tar.gz",
    "platform": null,
    "description": "# Missim Config\n\nMissim Config is used to load config stored inside the `~/.config/greenroom` folder.\n\n## Install\n\n* `pip install -e ./packages/missim_config`\n\n## Usage\n\n### Reading config\n\n```python\nfrom missim_config import read\n\nconfig = read()\n```\n\n### Writing config\n\n```python\nfrom missim_config import write, MissimConfig\n\nconfig = MissimConfig()\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 missim_config.generate_schemas\n```\n",
    "bugtrack_url": null,
    "license": "Copyright (C) 2023, Greenroom Robotics",
    "summary": "A library for reading / writing Missim config files",
    "version": "1.18.0",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/missim"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b035c32f1e3528cb4abcb25faf1efe94281a7f3a6531e67ab99b32b71baf6e92",
                "md5": "22a02787c0dd0e313c076641832db23e",
                "sha256": "3821047034dab5737883e01e1ed13bebecbe01ee7940c77834a0dd278521befa"
            },
            "downloads": -1,
            "filename": "missim_config-1.18.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "22a02787c0dd0e313c076641832db23e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8202,
            "upload_time": "2024-12-15T21:52:46",
            "upload_time_iso_8601": "2024-12-15T21:52:46.789141Z",
            "url": "https://files.pythonhosted.org/packages/b0/35/c32f1e3528cb4abcb25faf1efe94281a7f3a6531e67ab99b32b71baf6e92/missim_config-1.18.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff966d6b2528c44899fbb0ace85b8fc1cc6ce706c8ccd23286e55ffc5bdad275",
                "md5": "8df56139f40e4093973bffe3559f8884",
                "sha256": "76337d3a6aaac050885fd96d5a2f149ec7f1800af56f8f155d919a0695e3e5b8"
            },
            "downloads": -1,
            "filename": "missim_config-1.18.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8df56139f40e4093973bffe3559f8884",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6426,
            "upload_time": "2024-12-15T21:52:49",
            "upload_time_iso_8601": "2024-12-15T21:52:49.010483Z",
            "url": "https://files.pythonhosted.org/packages/ff/96/6d6b2528c44899fbb0ace85b8fc1cc6ce706c8ccd23286e55ffc5bdad275/missim_config-1.18.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-15 21:52:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "missim",
    "github_not_found": true,
    "lcname": "missim-config"
}