pyya 0.1.0__tar.gz

pyya-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 shadowy-pycoder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyya-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: pyya
+Version: 0.1.0
+Summary: Convert YAML configuration files to Python objects
+Author-email: shadowy-pycoder <shadowy-pycoder@example.com>
+Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
+Project-URL: Repository, https://github.com/shadowy-pycoder/pyya
+Project-URL: Issues, https://github.com/shadowy-pycoder/pyya/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: camel-converter>=3.1.2
+Requires-Dist: munch>=4.0.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: types-pyyaml>=6.0.12.20240917
+
+# paya - Simple tool that converts YAML configuration files to Python objects
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
+## Installation
+
+```shell
+pip install pyya
+```
+
+## Usage
+
+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
+```
+
+```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', 
+    convert_keys_to_snake_case = False,
+    raise_error_non_identifiers = False)
+print(json.dumps(config.database))
+
+# Output:
+# {"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 [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
+
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+
+If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+
+## Contributing
+
+Are you a developer?
+
+- Fork the repository
+- 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

pyya-0.1.0/README.md

@@ -0,0 +1,67 @@
+# paya - Simple tool that converts YAML configuration files to Python objects
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
+## Installation
+
+```shell
+pip install pyya
+```
+
+## Usage
+
+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
+```
+
+```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', 
+    convert_keys_to_snake_case = False,
+    raise_error_non_identifiers = False)
+print(json.dumps(config.database))
+
+# Output:
+# {"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 [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
+
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+
+If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+
+## Contributing
+
+Are you a developer?
+
+- Fork the repository
+- 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

pyya-0.1.0/pyproject.toml

@@ -0,0 +1,118 @@
+[project]
+name = "pyya"
+version = "0.1.0"
+authors = [
+  { name="shadowy-pycoder", email="shadowy-pycoder@example.com" },
+]
+description = "Convert YAML configuration files to Python objects"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+]
+dependencies = [
+    "camel-converter>=3.1.2",
+    "munch>=4.0.0",
+    "pyyaml>=6.0.2",
+    "types-pyyaml>=6.0.12.20240917",
+]
+[project.urls]
+Homepage = "https://github.com/shadowy-pycoder/pyya"
+Repository = "https://github.com/shadowy-pycoder/pyya"
+Issues = "https://github.com/shadowy-pycoder/pyya/issues"
+
+[tool.setuptools]
+license-files = []
+
+[tool.mypy]
+python_version = "3.8"
+cache_dir = ".mypy_cache/strict"
+allow_redefinition = true
+strict_optional = false
+show_error_codes = true
+show_column_numbers = true
+warn_no_return = true
+disallow_any_unimported = false
+warn_unused_configs = true
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+implicit_reexport = true
+strict_equality = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+pythonpath = "."
+filterwarnings = [
+    "ignore::DeprecationWarning",
+    "ignore::PendingDeprecationWarning",
+    "ignore::ImportWarning",
+    "ignore::ResourceWarning"
+]
+asyncio_mode = "auto"
+env_files = ".test.env"
+env_override_existing_values = true
+
+[tool.ruff]
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+line-length = 120
+indent-width = 4
+target-version = "py38"
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint]
+select = ["E1", "E2", "E4", "E7", "E9", "F", "D3"]
+ignore = ["ANN201", "Q000", "D102", "D103"]
+fixable = ["ALL"]
+unfixable = []
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.isort]
+lines-after-imports = 2

pyya-0.1.0/pyya/__init__.py

@@ -0,0 +1,71 @@
+import keyword
+import logging
+from pathlib import Path
+from typing import Any, Dict, Optional, Union
+
+import yaml
+from camel_converter import to_snake
+from munch import Munch, munchify
+
+
+logging.basicConfig(format='%(asctime)-15s \t%(levelname)-8s \t%(name)-8s \t%(message)s')
+logger = logging.getLogger('paya')
+
+
+ConfigType = Dict[str, Any]
+
+
+class PayaError(RuntimeError): ...
+
+
+def init_config(
+    config: Union[str, Path] = 'config.yaml',
+    default_config: Union[str, Path] = 'default.config.yaml',
+    *,
+    convert_keys_to_snake_case: bool = False,
+    raise_error_non_identifiers: bool = False,
+) -> Munch:
+    def _merge_configs(_raw_data: ConfigType, _default_raw_data: ConfigType) -> None:
+        for section, entry in _default_raw_data.items():
+            if section not in _raw_data or _raw_data[section] is None:
+                section = _sanitize_section(section)
+                _raw_data[section] = entry
+                logger.warning(f'section `{section}` with value `{entry}` taken from {default_config}')
+            elif isinstance(entry, dict):
+                section = _sanitize_section(section)
+                _merge_configs(_raw_data[section], entry)
+
+    def _sanitize_section(section: str) -> str:
+        if convert_keys_to_snake_case:
+            logger.warning(f'converting section `{section}` to snake case')
+            section = to_snake(section)
+        if raise_error_non_identifiers and not section.isidentifier():
+            err_msg = f'section `{section}` is not a valid identifier, aborting'
+            logger.error(err_msg)
+            raise PayaError(err_msg)
+        if keyword.iskeyword(section):
+            logger.warning(f'section `{section}` is a keyword, renaming to `_{section}`')
+            section = f'_{section}'
+        return section
+
+    try:
+        with open(Path(default_config)) as fstream:
+            _default_raw_data: Optional[ConfigType] = yaml.safe_load(fstream)
+        if _default_raw_data is None:
+            raise FileNotFoundError()
+    except FileNotFoundError as e:
+        logger.error(e)
+        raise PayaError(f'{default_config} file is missing or empty') from None
+    try:
+        with open(Path(config)) as fstream:
+            _raw_data: ConfigType = yaml.safe_load(fstream) or {}
+    except FileNotFoundError:
+        logger.warning(f'{config} file not found, using {default_config}')
+        _raw_data = {}
+    _merge_configs(_raw_data, _default_raw_data)
+    try:
+        return munchify(_raw_data)
+    except Exception as e:
+        message = f'{default_config} file is corrupted: {repr(e)}'
+        logger.error(message)
+        raise PayaError(message) from None

pyya-0.1.0/pyya.egg-info/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: pyya
+Version: 0.1.0
+Summary: Convert YAML configuration files to Python objects
+Author-email: shadowy-pycoder <shadowy-pycoder@example.com>
+Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
+Project-URL: Repository, https://github.com/shadowy-pycoder/pyya
+Project-URL: Issues, https://github.com/shadowy-pycoder/pyya/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: camel-converter>=3.1.2
+Requires-Dist: munch>=4.0.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: types-pyyaml>=6.0.12.20240917
+
+# paya - Simple tool that converts YAML configuration files to Python objects
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
+## Installation
+
+```shell
+pip install pyya
+```
+
+## Usage
+
+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
+```
+
+```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', 
+    convert_keys_to_snake_case = False,
+    raise_error_non_identifiers = False)
+print(json.dumps(config.database))
+
+# Output:
+# {"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 [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
+
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+
+If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+
+## Contributing
+
+Are you a developer?
+
+- Fork the repository
+- 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

pyya-0.1.0/pyya.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+pyya/__init__.py
+pyya.egg-info/PKG-INFO
+pyya.egg-info/SOURCES.txt
+pyya.egg-info/dependency_links.txt
+pyya.egg-info/requires.txt
+pyya.egg-info/top_level.txt

pyya-0.1.0/pyya.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyya-0.1.0/pyya.egg-info/requires.txt

@@ -0,0 +1,4 @@
+camel-converter>=3.1.2
+munch>=4.0.0
+pyyaml>=6.0.2
+types-pyyaml>=6.0.12.20240917

pyya-0.1.0/pyya.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyya

pyya-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+