https://github.com/shadowy-pycoder/pyya
Convert YAML configuration files to Python objects
https://github.com/shadowy-pycoder/pyya
Last synced: 11 months ago
JSON representation
Convert YAML configuration files to Python objects
- Host: GitHub
- URL: https://github.com/shadowy-pycoder/pyya
- Owner: shadowy-pycoder
- License: mit
- Created: 2024-12-08T15:37:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-19T08:05:03.000Z (about 1 year ago)
- Last Synced: 2025-04-25T11:45:35.029Z (12 months ago)
- Language: Python
- Size: 42 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyya - Simple tool that converts YAML configuration files to Python objects
[](https://clickpy.clickhouse.com/dashboard/pyya)
[](https://pypi.org/project/pyya/)
[](https://opensource.org/licenses/MIT)
## Features
- Very `lightweight` and `simple` API (currently it contains only one function)
- `Easy` to use
- Based on popular and well-tested libraries (like `camel-converter`, `PyYAML` and `munch`)
- Automatically `merge` default and production configuration files
- Convert keys in configuration files to `snake_case`
## Installation
```shell
pip install pyya
```
Or download a specific version from [Releases](https://github.com/shadowy-pycoder/pyya/releases) page and install it with:
```shell
pip install /path/to/pyya-[version]-py3-none-any.whl
```
## Usage
### Example
Create YAML configuration files for your project:
```yaml
# default.config.yaml - this file usually goes to version control system
database:
host: localhost
port: 5432
username: postgres
password: postgres
redis:
host: localhost
port: 6379
```
```yaml
# config.yaml - this file for production usage
database:
username: username
password: password
```
Import configuration files in your Python code with `pyya`:
```python
import json
from pyya import init_config
config = init_config(
'config.yaml', 'default.config.yaml',
merge_configs = True,
sections_ignored_on_merge = ['redis'], # do not include redis on your config
convert_keys_to_snake_case = False,
add_underscore_prefix_to_keywords = False
raise_error_non_identifiers = False)
print(json.dumps(config))
# Output:
# {database: {"host": "localhost", "port": 5432, "username": "username", "password": "password"}}
```
As you can see, `pyya` automatically merges default config file with production config file.
Under the hood `pyya` uses [PyYAML](https://pypi.org/project/PyYAML/) to parse YAML files and [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
### Flags
```python
# merge default and production configuration files
# setting to `False` disables other flags and makes default config optional
# `False` means "open config file and apply `ymal.safe_load` and `munchify` with no formatting"
merge_configs=True
```
```python
# list of sections to ignore when merging configs
# it is useful when you have examples in your default config but do not want to have in the main one
sections_ignored_on_merge: Optional[List[str]] = None
```
```python
# convert `camelCase` or `PascalCase` keys to `snake_case`
convert_keys_to_snake_case=True
```
```python
# add underscore prefix to keys that are Python keywords
add_underscore_prefix_to_keywords=True
```
```python
# raise error if key name is not valid Python identifier
raise_error_non_identifiers=True
```
## Contributing
Are you a developer?
- Fork the repository `https://github.com/shadowy-pycoder/pyya/fork`
- Clone the repository: `git clone https://github.com//pyya.git && cd pyya`
- Create your feature branch: `git switch -c my-new-feature`
- Commit your changes: `git commit -am 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request