gama-config

Name	gama-config JSON
Version	2.17.1 JSON
	download
home_page	https://github.com/Greenroom-Robotics/gama
Summary	A library for reading / writing GAMA config files
upload_time	2024-12-17 22:19:09
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.

            # GAMA Config

GAMA Config is used to load config stored inside the `.gama` folder.

## Install

* `pip install -e ./libs/gama_config`
* or...
* `pip install gama_config` (Public on [PyPi](https://pypi.org/project/gama-config/))

## Usage

### Reading config

```python
from gama_config.gama_vessel import read_vessel_config
from gama_config.gama_gs import read_gs_config

vessel_config = read_vessel_config()
gs_config = read_gs_config()

```

### Writing config

```python
from gama_config.gama_vessel import write_vessel_config, GamaVesselConfig
from gama_config.gama_gs import write_gs_config, GamaGsConfig

vessel_config = GamaVesselConfig()
gs_config = GamaGsConfig()

write_vessel_config(vessel_config)
write_gs_config(gs_config)

```

### Generating schemas

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

```bash
python3 -m gama_config.generate_schemas
```

## Running tests

```bash
python3 -m pytest -v ./libs/gama_config
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Greenroom-Robotics/gama",
    "name": "gama-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/4a/ae/b0e93c88a898e83798d955bcea30c37f94d6ad19d46cf90ac9b5c198bd1e/gama_config-2.17.1.tar.gz",
    "platform": null,
    "description": "# GAMA Config\n\nGAMA Config is used to load config stored inside the `.gama` folder.\n\n## Install\n\n* `pip install -e ./libs/gama_config`\n* or...\n* `pip install gama_config` (Public on [PyPi](https://pypi.org/project/gama-config/))\n\n## Usage\n\n### Reading config\n\n```python\nfrom gama_config.gama_vessel import read_vessel_config\nfrom gama_config.gama_gs import read_gs_config\n\nvessel_config = read_vessel_config()\ngs_config = read_gs_config()\n\n```\n\n### Writing config\n\n```python\nfrom gama_config.gama_vessel import write_vessel_config, GamaVesselConfig\nfrom gama_config.gama_gs import write_gs_config, GamaGsConfig\n\nvessel_config = GamaVesselConfig()\ngs_config = GamaGsConfig()\n\nwrite_vessel_config(vessel_config)\nwrite_gs_config(gs_config)\n\n```\n\n### Generating schemas\n\nAfter changing the dataclasses, you can generate the schemas with:\n\n```bash\npython3 -m gama_config.generate_schemas\n```\n\n## Running tests\n\n```bash\npython3 -m pytest -v ./libs/gama_config\n```\n",
    "bugtrack_url": null,
    "license": "Copyright (C) 2023, Greenroom Robotics",
    "summary": "A library for reading / writing GAMA config files",
    "version": "2.17.1",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/gama"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b892ac918bf81c5896ec300309808b5eb84047d7e9f1ef2b301d4d6b267ce07c",
                "md5": "06cb2656891fe2734c8ec04c732f46a2",
                "sha256": "d8d13aaf9c08657a4f2748868a5ed5c890aab1f0ca6319460b0356ef31dc073a"
            },
            "downloads": -1,
            "filename": "gama_config-2.17.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06cb2656891fe2734c8ec04c732f46a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 13975,
            "upload_time": "2024-12-17T22:19:07",
            "upload_time_iso_8601": "2024-12-17T22:19:07.216891Z",
            "url": "https://files.pythonhosted.org/packages/b8/92/ac918bf81c5896ec300309808b5eb84047d7e9f1ef2b301d4d6b267ce07c/gama_config-2.17.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4aaeb0e93c88a898e83798d955bcea30c37f94d6ad19d46cf90ac9b5c198bd1e",
                "md5": "ad78ec0951ab1ceb4bab376eb15d826d",
                "sha256": "068707ff081dbfe37d3b391c0bb29896b49f8bf942dbc2ad0984187995e32bd7"
            },
            "downloads": -1,
            "filename": "gama_config-2.17.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ad78ec0951ab1ceb4bab376eb15d826d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10478,
            "upload_time": "2024-12-17T22:19:09",
            "upload_time_iso_8601": "2024-12-17T22:19:09.490584Z",
            "url": "https://files.pythonhosted.org/packages/4a/ae/b0e93c88a898e83798d955bcea30c37f94d6ad19d46cf90ac9b5c198bd1e/gama_config-2.17.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-17 22:19:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "gama",
    "github_not_found": true,
    "lcname": "gama-config"
}