openconf 0.0.1__tar.gz

openconf-0.0.1/.coveragerc

@@ -0,0 +1,23 @@
+[run]
+source = openconf
+omit = openconf/__main__.py
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+    # Don't complain if an ellipsis isn't run (typically in an abstractmethod):
+    ^\s*\.\.\.

openconf-0.0.1/.editorconfig

@@ -0,0 +1,16 @@
+# http://editorconfig.org/#file-format-details
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

openconf-0.0.1/.envrc

@@ -0,0 +1,2 @@
+watch_file pixi.lock
+eval "$(pixi shell-hook -e dev)"

openconf-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7.4.0
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

openconf-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Test
+
+on:
+  pull_request: {}
+  push:
+    branches: master
+  schedule:
+    - cron: '0 4 * * 1'  # Mondays at 4am UTC
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version: ['3.13']
+        os: [ubuntu-latest]
+
+    name: Test openconf ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7.4.0
+        with:
+          enable-cache: true
+      - name: Install Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - run: uv run ruff format .
+      - run: uv run ruff check .
+      - run: uv run ty check .
+
+      - name: Regular tests
+        if: github.event_name != 'schedule'
+        run: uv run pytest --cov --cov-report=xml
+
+      - name: Regression tests nightly
+        if: github.event_name == 'schedule'
+        run: uv run pytest -m 'regression or not regression' --cov --cov-report=xml
+
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

openconf-0.0.1/.gitignore

@@ -0,0 +1,185 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+# Pixi
+.pixi
+
+# Benchmark scratch files
+scripts/*.log
+memory/
+
+static/iridium

openconf-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+exclude: '.pixi/'
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: check-yaml
+    - id: check-toml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+
+- repo: local
+  hooks:
+  - id: ruff
+    name: ruff-format
+    stages: [pre-commit, pre-push]
+    language: system
+    entry: uv run ruff format .
+    types: [python]
+    pass_filenames: false
+
+  - id: ruff
+    name: ruff-check
+    stages: [pre-commit, pre-push]
+    language: system
+    entry: uv run ruff check . --fix
+    types: [python]
+    pass_filenames: false
+
+  - id: ty
+    name: ty
+    stages: [pre-commit, pre-push]
+    language: system
+    entry: uv run ty check
+    types: [python]
+    pass_filenames: false
+
+  - id: pytest
+    name: pytest
+    stages: [pre-commit, pre-push]
+    language: system
+    entry: uv run pytest
+    types: [python]
+    pass_filenames: false

openconf-0.0.1/AGENTS.md

@@ -0,0 +1,288 @@
+# AI Agent Development Guide
+
+This document provides essential guidance for AI agents working on this repository. It covers tooling, conventions, and workflows needed to contribute effectively.
+
+## How to use this document
+
+### When to read this file
+- First time working on this repository
+- Before making any code changes or commits
+- When unsure about code conventions or tooling
+
+## Before every commit
+- Ensure all code has type annotations
+- Add Google-style docstrings (NO types, NO leading articles)
+- Pre-commit hooks will run automatically and must pass
+
+## When in doubt
+- Check code conventions section below
+- Run individual tools to identify issues
+- Ask user for clarification on ambiguous requirements
+
+## Code conventions
+
+### Docstrings
+
+Required for: all public modules, classes, functions, and methods
+
+#### Format: Google-style
+1. Do not place type information in docstrings - use type annotations only
+2. Do not use leading articles in parameter, return, and error descriptions "a", "an", or "the"
+
+##### Section order
+1. Args
+2. Returns
+3. Raises
+4. Yields
+5. Examples
+6. Note
+7. Warning
+
+#### Example
+```python
+def process_data(input_data: list[str], threshold: int = 10) -> dict[str, int]:
+    """Process input data and return summary statistics.
+
+    Args:
+        input_data: strings to process
+        threshold: minimum count threshold for inclusion
+
+    Returns:
+        Mapping of categories to counts
+
+    Examples:
+        >>> process_data(["a", "b"], 5)
+        {"valid": 2}
+    """
+```
+
+#### Incorrect example (do not do this!)
+```python
+def process_data(input_data: list[str], threshold: int = 10) -> dict[str, int]:
+    """Process input data and return summary statistics.
+
+    Args:
+        input_data (list[str]): A list of strings to process.  # ❌ Has type and article
+        threshold (int): A minimum count threshold.            # ❌ Has type and article
+
+    Returns:
+        dict[str, int]: A dictionary mapping categories.       # ❌ Has type and article
+    """
+```
+
+### Type annotations
+
+Requirements
+- All functions must have complete type annotations
+- Use modern syntax: `list[str]`, `dict[str, int]` (not `List[str]`, `Dict[str, int]`)
+- Use `|` for union types (Python 3.10+): `str | None`
+- Import types from `typing` only when necessary (prefer built-ins)
+
+#### Verification
+```bash
+pixi run types
+```
+
+### Code formatting
+
+Via ruff
+- Line length: 120
+- Indentation: 4 spaces (no tabs except Makefiles)
+- Encoding: UTF-8
+- Line endings: LF (Unix-style)
+- Trailing newline: required
+- No trailing whitespace
+
+### Naming conventions
+- Functions/methods: snake_case
+- Variables: snake_case
+- Constants: UPPER_SNAKE_CASE
+- Classes: PascalCase
+- Modules: snake_case
+- Private attributes/methods: _leading_underscore
+
+### Imports
+- Absolute imports preferred
+- Group imports: standard library, third-party, local
+- No wildcard imports (`from module import *`) except in `__init__.py`
+- Import sorting handled by ruff (isort)
+
+### Error handling
+- Use specific exceptions (ValueError, OSError, etc.) rather than generic Exception
+- Avoid bare `except:` clauses; catch specific exceptions
+- Use context managers (`with` statements) for resource management
+- Log errors appropriately using the `logging` module
+- Raise custom exceptions for domain-specific errors
+
+### General style
+- Use f-strings for string formatting (Python 3.6+)
+- Prefer list/dict comprehensions over loops when appropriate
+- Use `pathlib.Path` for file operations instead of `os.path`
+- Avoid global variables; use dependency injection
+- Write readable code; prefer explicit over implicit
+
+## Essential commands
+
+```bash
+# Setup
+pixi install                    # Install dependencies
+
+# Code quality
+pixi run fmt                         # Format code
+pixi run lint                        # Lint code
+pixi run types                       # Type check
+
+# Testing
+pixi run test                   # Run tests
+pixi run test --cov             # Run tests with coverage
+pixi run test -k "pattern"      # Run test matching pattern
+pixi run test -v                # Verbose output
+
+# Git workflow
+git add .
+git commit -m "feat: message"   # Hooks run automatically
+
+# Package management
+pixi add <package>                # Add a package
+pixi add --dev <package>          # Add a package to dev
+pixi lock                         # Check the lockfile matches the pyproject.toml (and update if different)
+pixi update                       # Update all packges in the lockfile
+pixi tree                         # Print the dependencies tree
+```
+
+## Code quality tools
+
+### Ruff (formatting & linting)
+
+Enabled rule categories:
+- `B` - bugbear (common bugs and design problems)
+- `D` - pydocstyle (docstring conventions)
+- `E`/`W` - pycodestyle (PEP 8 style errors and warnings)
+- `F` - pyflakes (logical errors)
+- `I` - isort (import sorting)
+- `N` - pep8-naming (naming conventions)
+- `C4` - comprehensions (list/dict/set comprehension improvements)
+- `PL` - pylint (code quality and error detection)
+- `PT` - pytest-style (pytest best practices)
+- `PIE` - misc lints (miscellaneous improvements)
+- `PYI` - flake8-pyi (stub file best practices)
+- `TID` - tidy imports (import hygiene)
+- `TCH` - type-checking imports (TYPE_CHECKING block enforcement)
+- `RUF` - Ruff-specific rules
+- `RSE` - flake8-raise (exception raising improvements)
+- `ICN001` - unconventional import aliases
+
+Ignored rules (globally):
+- `N806` - Non-lowercase variable in function (allows PascalCase variables)
+- `PLR0911` - Too many return statements
+- `PLR0912` - Too many branches
+- `PLR0913` - Too many arguments to function call
+- `PLR0914` - Too many local variables
+- `PLR0915` - Too many statements
+- `PLR1702` - Too many nested blocks
+
+Per-file ignores:
+- `__init__.py`:
+  - `F401` - Unused imports (common for `__all__` exports)
+  - `F403` - `from module import *` (acceptable in `__init__.py`)
+
+Configuration: `pyproject.toml` under `[tool.ruff]` and `[tool.ruff.lint]`
+
+### Ty (type checking)
+
+Requirements:
+- All functions must have complete type annotations
+- Modern syntax required (e.g., `list[str]` not `List[str]`)
+
+### Pytest (testing)
+
+Configuration:
+- Test paths:
+  - `tests/` - Unit and integration tests
+  - `{{cookiecutter.package_name}}` - Source code (for doctests)
+- Doctests: Enabled automatically via `--doctest-modules` flag
+- Doctest normalization: `NORMALIZE_WHITESPACE` applied to all doctests (allows flexible spacing in examples)
+
+Both test files in `tests/` and docstring examples in source code are automatically discovered and run
+
+## Testing
+
+### Test structure
+
+- Location: `tests/` directory
+- Naming: test files must start with `test_`
+- Doctests: automatically discovered in source code
+
+### Doctests
+
+Include examples in docstrings:
+```python
+def add(a: int, b: int) -> int:
+    """Add two integers.
+
+    Args:
+        a: first integer
+        b: second integer
+
+    Returns:
+        Sum of a and b
+
+    Examples:
+        >>> add(2, 3)
+        5
+        >>> add(-1, 1)
+        0
+    """
+    return a + b
+```
+
+
+## Troubleshooting
+
+### Pre-commit hook failures
+
+Formatting issues:
+- Usually auto-fixed by ruff
+- Re-stage files: `git add .`
+- Try committing again
+
+Lint issues:
+- Read error message for specific rule
+- Fix; if `# noqa: <rule>` if absolutely necessary, ask before adding
+
+Type issues:
+- Add missing type annotations
+- Fix type mismatches
+- Use `pixi run types` to verify locally
+
+Test failures:
+- Fix failing tests or code
+- Run `pixi run test -v` for detailed output
+- Run specific test: `pixi run test hooks/test_file.py::test_name`
+
+## Commit guidelines
+
+Format: conventional commits recommended
+- `feat:` - new features
+- `fix:` - bug fixes
+- `docs:` - documentation changes
+- `test:` - test changes
+- `refactor:` - code refactoring
+- `chore:` - maintenance tasks
+
+### Example
+```bash
+git commit -m "feat: add user authentication
+
+- Implement JWT token generation
+- Add login/logout endpoints
+- Include comprehensive tests"
+```
+
+## Additional resources
+
+- pixi documentation: https://pixi.sh
+- ruff documentation: https://docs.astral.sh/ruff
+- ty documentation: https://github.com/astral-sh/ty
+- pytest documentation: https://docs.pytest.org
+- Google docstring style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings

openconf-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Corin Wagen
+
+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.