missim-config

Name	missim-config JSON
Version	1.20.0 JSON
	download
home_page	https://github.com/Greenroom-Robotics/missim
Summary	A library for reading / writing Missim config files
upload_time	2025-02-03 23:20:29
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/fa/6d/ec9a2e1d4b0abd81595339311b51e2903a51263f217216e760d66af4b92a/missim_config-1.20.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.20.0",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/missim"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d1cee78cd7ca0a472a3607a3ac82da9f139f23e1cd6c9780a6cdca67128a65b2",
                "md5": "0b0869c8fc6e697843414a7c9070eb41",
                "sha256": "3a3a9ae10454b24e58c641d2e9f6e32321c4c24aaff6011a4de2be39e7e4d88f"
            },
            "downloads": -1,
            "filename": "missim_config-1.20.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0b0869c8fc6e697843414a7c9070eb41",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8201,
            "upload_time": "2025-02-03T23:20:28",
            "upload_time_iso_8601": "2025-02-03T23:20:28.479241Z",
            "url": "https://files.pythonhosted.org/packages/d1/ce/e78cd7ca0a472a3607a3ac82da9f139f23e1cd6c9780a6cdca67128a65b2/missim_config-1.20.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fa6dec9a2e1d4b0abd81595339311b51e2903a51263f217216e760d66af4b92a",
                "md5": "0f81b1bfb150cac3c5b44bbe6dd343e0",
                "sha256": "e59a83a7b24b54691f99ddfde291ad41b552d99127d6462d6cc9ac5eefbb14ce"
            },
            "downloads": -1,
            "filename": "missim_config-1.20.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0f81b1bfb150cac3c5b44bbe6dd343e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6417,
            "upload_time": "2025-02-03T23:20:29",
            "upload_time_iso_8601": "2025-02-03T23:20:29.519611Z",
            "url": "https://files.pythonhosted.org/packages/fa/6d/ec9a2e1d4b0abd81595339311b51e2903a51263f217216e760d66af4b92a/missim_config-1.20.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-03 23:20:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "missim",
    "github_not_found": true,
    "lcname": "missim-config"
}