Metadata-Version: 2.2
Name: gama_config
Version: 3.13.0
Summary: A library for reading / writing GAMA config files
Home-page: https://github.com/Greenroom-Robotics/gama
Author: Greenroom Robotics
Author-email: team@greenroomrobotics.com
Maintainer: David Revay
Maintainer-email: david.revay@greenroomrobotics.com
License: Copyright (C) 2023, Greenroom Robotics
Keywords: colcon
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Build Tools
Description-Content-Type: text/markdown
Requires-Dist: setuptools
Requires-Dist: dacite
Requires-Dist: PyYAML
Requires-Dist: greenstream-config==3.18.2
Requires-Dist: gr-urchin

# 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
```
