confkit 0.1.1__tar.gz

confkit-0.1.1/.github/workflows/pypi.yml

@@ -0,0 +1,50 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: 
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        uv
+    - name: Build a binary wheel and a source tarball
+      run: uv build --sdist --wheel --out-dir dist
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/confkit
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

confkit-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python
+      run: uv python install 3.13
+    
+    - name: Install dependencies
+      run: uv sync --group dev
+    
+    - name: Run tests
+      run: uv run pytest .
+    
+    - name: Run ruff check
+      run: uv run ruff check .
+    
+    - name: Run type checking
+      run: uvx ty check .

confkit-0.1.1/.gitignore

@@ -0,0 +1,207 @@
+# https://github.com/github/gitignore/blob/main/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Custom ignores
+test.ini

confkit-0.1.1/.python-version

@@ -0,0 +1 @@
+3.13

confkit-0.1.1/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "cSpell.words": [
+        "confkit"
+    ],
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

confkit-0.1.1/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: confkit
+Version: 0.1.1
+Summary: Lightweight and Easy to use configuration manager for Python projects
+Author-email: HEROgold <martijnwieringa28@gmail.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# confkit
+
+[![Test](https://github.com/HEROgold/confkit/actions/workflows/test.yml/badge.svg)](https://github.com/HEROgold/confkit/actions/workflows/test.yml)
+
+Type-safe configuration manager for Python projects using descriptors and ConfigParser.
+
+## What is it?
+
+confkit is a Python library that provides type-safe configuration management with automatic type conversion and validation.
+It uses descriptors to define configuration values as class attributes that automatically read from and write to INI files.
+
+## What does it do?
+
+- Type-safe configuration with automatic type conversion
+- Automatic INI file management
+- Default value handling with file persistence
+- Optional value support
+- Enum support (Enum, StrEnum, IntEnum, IntFlag)
+- Method decorators for injecting configuration values
+- Runtime type validation
+
+## How to use it?
+
+### Setup
+
+```python
+from configparser import ConfigParser
+from pathlib import Path
+from confkit import Config
+
+parser = ConfigParser()
+Config.set_parser(parser)
+Config.set_file(Path("config.ini"))
+```
+
+### Basic Usage
+
+- Note: imports have been left out. see [examples/basic.py](basic.py) for the entire example.
+
+```python
+class AppConfig:
+    debug = Config(False)
+    port = Config(8080)
+    host = Config("localhost")
+    timeout = Config(30.5)
+    api_key = Config("", optional=True)
+
+config = AppConfig()
+print(config.debug)  # False
+config.port = 9000   # Automatically saves to config.ini if write_on_edit is true (default).
+```
+
+### Enums and Custom Types
+
+- Note: imports have been left out. see [examples/enums.py](enums.py) for the entire example.
+
+```python
+class LogLevel(StrEnum):
+    DEBUG = "debug"
+    INFO = "info"
+    ERROR = "error"
+
+class ServerConfig:
+    log_level = Config(ConfigEnum(LogLevel.INFO))
+    db_url = Config(String("sqlite:///app.db"))
+    fallback_level = Config(Optional(ConfigEnum(LogLevel.ERROR)))
+
+config = ServerConfig()
+config.log_level = LogLevel.DEBUG  # Type-safe
+```
+
+### Method Decorators
+
+- Note: imports have been left out. see [examples/decorators.py](decorators.py) for the entire example.
+
+```python
+class ServiceConfig:
+    retry_count = Config(3)
+    timeout = Config(30)
+
+    @Config.with_setting(retry_count)
+    def process(self, data, **kwargs):
+        retries = kwargs.get('retry_count')
+        return f"Processing with {retries} retries"
+
+    @Config.as_kwarg("ServiceConfig", "timeout", "request_timeout", 60)
+    def request(self, url, **kwargs):
+        timeout = kwargs.get('request_timeout')
+        return f"Request timeout: {timeout}s"
+
+service = ServiceConfig()
+result = service.process("data")  # Uses current retry_count
+```
+
+### Configuration File
+
+Generated INI file structure see [examples/config.ini](config.ini) for the entire example.:
+
+```ini
+[AppConfig]
+debug = False
+port = 9000
+host = localhost
+timeout = 30.5
+api_key = 
+
+[ServiceConfig]
+retry_count = 3
+timeout = 30
+
+[ServerConfig]
+log_level = debug
+db_url = sqlite:///app.db
+fallback_level = error
+```
+
+## How to contribute?
+
+1. Fork the repository and clone locally
+2. Install dependencies: `uv sync --group test`
+3. Run tests: `pytest .`
+4. Run linting: `ruff check .`
+5. Make changes following existing patterns
+6. Add tests for new functionality
+7. Submit a pull request
+
+### Development
+
+```bash
+git clone https://github.com/HEROgold/confkit.git
+cd confkit
+uv sync --group test
+pytest .
+ruff check .
+```

confkit-0.1.1/README.md

@@ -0,0 +1,135 @@
+# confkit
+
+[![Test](https://github.com/HEROgold/confkit/actions/workflows/test.yml/badge.svg)](https://github.com/HEROgold/confkit/actions/workflows/test.yml)
+
+Type-safe configuration manager for Python projects using descriptors and ConfigParser.
+
+## What is it?
+
+confkit is a Python library that provides type-safe configuration management with automatic type conversion and validation.
+It uses descriptors to define configuration values as class attributes that automatically read from and write to INI files.
+
+## What does it do?
+
+- Type-safe configuration with automatic type conversion
+- Automatic INI file management
+- Default value handling with file persistence
+- Optional value support
+- Enum support (Enum, StrEnum, IntEnum, IntFlag)
+- Method decorators for injecting configuration values
+- Runtime type validation
+
+## How to use it?
+
+### Setup
+
+```python
+from configparser import ConfigParser
+from pathlib import Path
+from confkit import Config
+
+parser = ConfigParser()
+Config.set_parser(parser)
+Config.set_file(Path("config.ini"))
+```
+
+### Basic Usage
+
+- Note: imports have been left out. see [examples/basic.py](basic.py) for the entire example.
+
+```python
+class AppConfig:
+    debug = Config(False)
+    port = Config(8080)
+    host = Config("localhost")
+    timeout = Config(30.5)
+    api_key = Config("", optional=True)
+
+config = AppConfig()
+print(config.debug)  # False
+config.port = 9000   # Automatically saves to config.ini if write_on_edit is true (default).
+```
+
+### Enums and Custom Types
+
+- Note: imports have been left out. see [examples/enums.py](enums.py) for the entire example.
+
+```python
+class LogLevel(StrEnum):
+    DEBUG = "debug"
+    INFO = "info"
+    ERROR = "error"
+
+class ServerConfig:
+    log_level = Config(ConfigEnum(LogLevel.INFO))
+    db_url = Config(String("sqlite:///app.db"))
+    fallback_level = Config(Optional(ConfigEnum(LogLevel.ERROR)))
+
+config = ServerConfig()
+config.log_level = LogLevel.DEBUG  # Type-safe
+```
+
+### Method Decorators
+
+- Note: imports have been left out. see [examples/decorators.py](decorators.py) for the entire example.
+
+```python
+class ServiceConfig:
+    retry_count = Config(3)
+    timeout = Config(30)
+
+    @Config.with_setting(retry_count)
+    def process(self, data, **kwargs):
+        retries = kwargs.get('retry_count')
+        return f"Processing with {retries} retries"
+
+    @Config.as_kwarg("ServiceConfig", "timeout", "request_timeout", 60)
+    def request(self, url, **kwargs):
+        timeout = kwargs.get('request_timeout')
+        return f"Request timeout: {timeout}s"
+
+service = ServiceConfig()
+result = service.process("data")  # Uses current retry_count
+```
+
+### Configuration File
+
+Generated INI file structure see [examples/config.ini](config.ini) for the entire example.:
+
+```ini
+[AppConfig]
+debug = False
+port = 9000
+host = localhost
+timeout = 30.5
+api_key = 
+
+[ServiceConfig]
+retry_count = 3
+timeout = 30
+
+[ServerConfig]
+log_level = debug
+db_url = sqlite:///app.db
+fallback_level = error
+```
+
+## How to contribute?
+
+1. Fork the repository and clone locally
+2. Install dependencies: `uv sync --group test`
+3. Run tests: `pytest .`
+4. Run linting: `ruff check .`
+5. Make changes following existing patterns
+6. Add tests for new functionality
+7. Submit a pull request
+
+### Development
+
+```bash
+git clone https://github.com/HEROgold/confkit.git
+cd confkit
+uv sync --group test
+pytest .
+ruff check .
+```

confkit-0.1.1/examples/basic.py

@@ -0,0 +1,21 @@
+
+from configparser import ConfigParser
+from pathlib import Path
+
+from confkit import Config
+
+parser = ConfigParser()
+Config.set_parser(parser)
+Config.set_file(Path("config.ini"))
+
+
+class AppConfig:
+    debug = Config(False)
+    port = Config(8080)
+    host = Config("localhost")
+    timeout = Config(30.5)
+    api_key = Config("", optional=True)
+
+config = AppConfig()
+print(config.debug)  # False
+config.port = 9000   # Automatically saves to config.ini if write_on_edit is true (default).

confkit-0.1.1/examples/config.ini

@@ -0,0 +1,16 @@
+[AppConfig]
+debug = False
+port = 9000
+host = localhost
+timeout = 30.5
+api_key = 
+
+[ServiceConfig]
+retry_count = 3
+timeout = 30
+
+[ServerConfig]
+log_level = debug
+db_url = sqlite:///app.db
+fallback_level = error
+

confkit-0.1.1/examples/decorators.py

@@ -0,0 +1,28 @@
+
+from configparser import ConfigParser
+from pathlib import Path
+from typing import Any
+
+from confkit.config import Config
+
+parser = ConfigParser()
+Config.set_parser(parser)
+Config.set_file(Path("config.ini"))
+
+
+class ServiceConfig:
+    retry_count = Config(3)
+    timeout = Config(30)
+
+    @Config.with_setting(retry_count)
+    def process(self, _data: Any, **kwargs: Any) -> str:
+        retries = kwargs.get("retry_count")
+        return f"Processing with {retries} retries"
+
+    @Config.as_kwarg("ServiceConfig", "timeout", "request_timeout", 60)
+    def request(self, _url: Any, **kwargs: Any) -> str:
+        timeout = kwargs.get("request_timeout")
+        return f"Request timeout: {timeout}s"
+
+service = ServiceConfig()
+result = service.process("data")  # Uses current retry_count

confkit-0.1.1/examples/enums.py

@@ -0,0 +1,25 @@
+
+from configparser import ConfigParser
+from enum import StrEnum
+from pathlib import Path
+
+from confkit import Config, Optional, String
+from confkit import StrEnum as ConfigEnum
+
+parser = ConfigParser()
+Config.set_parser(parser)
+Config.set_file(Path("config.ini"))
+
+
+class LogLevel(StrEnum):
+    DEBUG = "debug"
+    INFO = "info"
+    ERROR = "error"
+
+class ServerConfig:
+    log_level = Config(ConfigEnum(LogLevel.INFO))
+    db_url = Config(String("sqlite:///app.db"))
+    fallback_level = Config(Optional(ConfigEnum(LogLevel.ERROR)))
+
+config = ServerConfig()
+config.log_level = LogLevel.DEBUG  # Type-safe

confkit-0.1.1/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "confkit"
+version = "0.1.1"
+description = "Lightweight and Easy to use configuration manager for Python projects"
+readme = "README.md"
+authors = [
+    { name = "HEROgold", email = "martijnwieringa28@gmail.com" }
+]
+requires-python = ">=3.13"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "coverage>=7.10.1",
+    "pytest-cov>=6.2.1",
+    "hypothesis>=6.136.7",
+    "pytest>=8.4.1",
+    "ruff>=0.8.0",
+]