confuk 0.1.0__tar.gz

confuk-0.1.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: confuk
+Version: 0.1.0
+Summary: Very opinionated configuration loading package for Python projects
+License: MIT
+Author: Krzysztof J. Czarnecki
+Author-email: kjczarne@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: easydict (>=1.11,<2.0)
+Requires-Dist: pydantic (>=2.5.3,<3.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Description-Content-Type: text/markdown
+
+# Confuk
+
+This is yet another package for managing configuration files in Python projects.
+
+At the moment all it does is it exposes a consistent API that lets you provide a path to a TOML configuration file. It parses the config file into a dictionary by default. If a config class is provided when parsing, the class instance will be created using a dictionary of keyword arguments coming from the original TOML file.
+
+In human words: I made this package so that I don't have to explicilty load, parse and return a class instance every single time I have something to do with a TOML file:
+
+```python
+from confuk import parse_config
+from pathlib import Path
+from somewhere import ConfigClass
+
+cfg_dict = parse_config(Path("some.toml"))  # returns a dictionary
+cfg_obj = parse_config(Path("some.toml"), ConfigClass)  # returns an instance of `ConfigClass`
+```
+
+## Installation
+
+Currently you can build the package using Poetry:
+
+1. Clone this repo.
+2. Run `poetry build`.
+3. Grab the installable wheel from the `dist` folder and install it with `pip` or add the package as a local dependency of another project.
+
+Once I get some time to take care of it I will add the package to PyPI so that it's installable via a simple `pip install confuk` command.
+

confuk-0.1.0/README.md

@@ -0,0 +1,26 @@
+# Confuk
+
+This is yet another package for managing configuration files in Python projects.
+
+At the moment all it does is it exposes a consistent API that lets you provide a path to a TOML configuration file. It parses the config file into a dictionary by default. If a config class is provided when parsing, the class instance will be created using a dictionary of keyword arguments coming from the original TOML file.
+
+In human words: I made this package so that I don't have to explicilty load, parse and return a class instance every single time I have something to do with a TOML file:
+
+```python
+from confuk import parse_config
+from pathlib import Path
+from somewhere import ConfigClass
+
+cfg_dict = parse_config(Path("some.toml"))  # returns a dictionary
+cfg_obj = parse_config(Path("some.toml"), ConfigClass)  # returns an instance of `ConfigClass`
+```
+
+## Installation
+
+Currently you can build the package using Poetry:
+
+1. Clone this repo.
+2. Run `poetry build`.
+3. Grab the installable wheel from the `dist` folder and install it with `pip` or add the package as a local dependency of another project.
+
+Once I get some time to take care of it I will add the package to PyPI so that it's installable via a simple `pip install confuk` command.

confuk-0.1.0/confuk/__init__.py

@@ -0,0 +1 @@
+from .parse import parse_config

confuk-0.1.0/confuk/parse.py

@@ -0,0 +1,52 @@
+import toml
+from typing import Type, Any, Literal
+from pydantic import BaseModel
+from pathlib import Path
+from easydict import EasyDict as edict
+
+CfgClass = Type[Any]
+PydanticCfgClass = Type[BaseModel]
+
+
+def _parse_config_dict(toml_file: Path):
+    with open(toml_file, 'r') as file:
+        config_dict = toml.load(file)
+        return config_dict
+
+
+def _parse_config_kwarg_constructor(toml_file: Path, cfg_class: CfgClass):
+    config_dict = _parse_config_dict(toml_file)
+    config = cfg_class(**config_dict)
+    return config
+
+
+def _parse_config_pydantic(toml_file: Path, cfg_class: PydanticCfgClass):
+    return _parse_config_kwarg_constructor(toml_file, cfg_class)
+
+
+def _parse_config_easydict(toml_file: Path):
+    config_dict = _parse_config_dict(toml_file)
+    return edict(config_dict)
+
+
+def parse_config(toml_file: Path, cfg_class: CfgClass | Literal["attr"] | None = None):
+    """Takes a path object to a toml file and returns a config object.
+
+    Args:
+        toml_file (Path): path to the toml file
+        cfg_class (CfgClass | Literal["attr"], optional): config loader class. Defaults to None.
+            If set to `"attr"`, the config will be loaded as an `easydict` object instead
+            of a conventional dictionary.
+
+    Returns:
+        An instance of the class used to load the config
+    """
+    match cfg_class:
+        case None:
+            return _parse_config_dict(toml_file)
+        case "attr":
+            return _parse_config_easydict(toml_file)
+        case BaseModel():
+            return _parse_config_pydantic(toml_file, cfg_class)
+        case _:
+            return _parse_config_kwarg_constructor(toml_file, cfg_class)

confuk-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[tool.poetry]
+name = "confuk"
+version = "0.1.0"
+description = "Very opinionated configuration loading package for Python projects"
+authors = ["Krzysztof J. Czarnecki <kjczarne@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+toml = "^0.10.2"
+pydantic = "^2.5.3"
+easydict = "^1.11"
+
+[tool.poetry.group.dev.dependencies]
+poethepoet = "^0.24.4"
+pylint = "^3.0.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"