dotenvmodel 0.1.1__tar.gz

dotenvmodel-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,120 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Lint with ruff
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Type check with ty
+        run: uv run ty check dotenvmodel
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest tests/
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v3
+        if: matrix.python-version == '3.12'
+        with:
+          file: ./coverage.xml
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [lint, typecheck, test]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Build package
+        run: uv build
+
+      - name: Check package contents
+        run: |
+          ls -la dist/
+          uv run python -m tarfile -l dist/*.tar.gz
+          uv run python -m zipfile -l dist/*.whl
+
+      - name: Test installation from wheel
+        run: |
+          uv venv test-env
+          uv pip install --python test-env/bin/python dist/*.whl
+          cd /tmp && $GITHUB_WORKSPACE/test-env/bin/python -c "import dotenvmodel; print(dotenvmodel.__version__)"
+
+      - name: Test installation from source distribution
+        run: |
+          uv venv test-src-env
+          uv pip install --python test-src-env/bin/python dist/*.tar.gz
+          cd /tmp && $GITHUB_WORKSPACE/test-src-env/bin/python -c "import dotenvmodel; print(dotenvmodel.__version__)"
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7

dotenvmodel-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on:
+  workflow_call:
+    inputs:
+      release_created:
+        required: true
+        type: boolean
+      tag_name:
+        required: true
+        type: string
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: inputs.release_created || github.event_name == 'release' || github.event_name == 'workflow_dispatch'
+    permissions:
+      id-token: write
+      contents: read
+
+    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
+
+    - name: Install dependencies
+      run: uv sync --all-extras --group dev
+
+    - name: Run tests
+      run: uv run pytest tests/ -v
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        uv tool install twine
+        uv tool run twine upload dist/*

dotenvmodel-0.1.1/.github/workflows/release-please.yml

@@ -0,0 +1,35 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+  issues: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+          package-name: dotenvmodel
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: release-please
+    if: needs.release-please.outputs.release_created
+    uses: ./.github/workflows/publish.yml
+    with:
+      release_created: true
+      tag_name: ${{ needs.release-please.outputs.tag_name }}
+    secrets: inherit

dotenvmodel-0.1.1/.gitignore

@@ -0,0 +1,207 @@
+# 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
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

dotenvmodel-0.1.1/.python-version

@@ -0,0 +1 @@
+3.12

dotenvmodel-0.1.1/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.1"
+}

dotenvmodel-0.1.1/.vscode/settings.json

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

dotenvmodel-0.1.1/CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1](https://github.com/AZX-PBC/dotenvmodel/compare/v0.1.0...v0.1.1) (2025-12-05)
+
+
+### Bug Fixes
+
+* update PyPI publishing workflow configuration ([f854abb](https://github.com/AZX-PBC/dotenvmodel/commit/f854abb08272c51e1a872d4062230f8b2e7d5c21))
+* update PyPI publishing workflow configuration ([8c3ed30](https://github.com/AZX-PBC/dotenvmodel/commit/8c3ed301b7aa3fffcffb2343a0f194cce639832a))
+
+## 0.1.0 (2025-12-05)
+
+
+### Features
+
+* v0.1.0 - Complete type-safe environment configuration library ([#1](https://github.com/AZX-PBC/dotenvmodel/issues/1)) ([7e9b2a9](https://github.com/AZX-PBC/dotenvmodel/commit/7e9b2a9cf01db778b0855df40745eac1d2134de5))
+
+## [0.1.0] - 2025-12-05
+
+### Added
+
+- **Core Configuration System**
+  - `DotEnvConfig` base class with metaclass-based field discovery
+  - Type-safe field definitions with full IntelliSense support
+  - Automatic type coercion for common Python types
+
+- **Type Support**
+  - Basic types: `str`, `int`, `float`, `bool`, `Path`
+  - Collection types: `list`, `set`, `tuple`, `dict`
+  - Special types: `UUID`, `Decimal`, `datetime`, `timedelta`
+  - URL/DSN types: `HttpUrl`, `PostgresDsn`, `RedisDsn`
+  - Security: `SecretStr` for sensitive values
+  - Flexible: `Json[T]` for typed JSON parsing
+
+- **Validation**
+  - Numeric constraints: `ge`, `le`, `gt`, `lt`
+  - String constraints: `min_length`, `max_length`, `regex`
+  - Choice validation
+  - Collection size constraints: `min_items`, `max_items`
+  - UUID version validation
+
+- **Environment Management**
+  - Automatic .env file loading with cascading (`.env`, `.env.{env}`, `.env.{env}.local`)
+  - Support for multiple environments (dev, prod, test, staging)
+  - Custom .env file locations via `env_dir` parameter
+  - Override control with `override` parameter
+
+- **Advanced Features**
+  - **Configuration Reload**: `reload()` method to update config at runtime without creating new instances
+  - **Environment Prefixes**: Class-level `env_prefix` to namespace environment variables
+  - Field aliases for environment variable names
+  - Default values and factories
+  - Optional fields with proper None handling
+
+- **Developer Experience**
+  - Comprehensive error messages with helpful hints
+  - Optional logging support for debugging
+  - `load_from_dict()` for testing without environment variables
+  - Helper methods: `dict()`, `get()`, `__repr__()`
+
+- **Testing & Quality**
+  - 315 comprehensive tests
+  - 98% code coverage
+  - Full type safety with py.typed marker
+  - Linting with ruff
+  - CI/CD ready configuration
+
+- **Documentation**
+  - Comprehensive README with examples
+  - Type safety and IntelliSense documentation
+  - Complete API documentation
+  - Advanced usage patterns and best practices
+
+### Changed
+
+- N/A (initial release)
+
+### Deprecated
+
+- N/A (initial release)
+
+### Removed
+
+- N/A (initial release)
+
+### Fixed
+
+- N/A (initial release)
+
+### Security
+
+- No known security issues
+
+[0.1.0]: https://github.com/azxio/dotenvmodel/releases/tag/v0.1.0

dotenvmodel-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AZX, PBC.
+
+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.

dotenvmodel-0.1.1/Makefile

@@ -0,0 +1,45 @@
+.PHONY: help install test lint format type-check clean build publish
+
+help:
+	@echo "Available commands:"
+	@echo "  make install      - Install package and dev dependencies"
+	@echo "  make test         - Run tests with coverage"
+	@echo "  make lint         - Run ruff linter"
+	@echo "  make format       - Format code with ruff"
+	@echo "  make type-check   - Run mypy type checker"
+	@echo "  make clean        - Clean build artifacts"
+	@echo "  make build        - Build package"
+	@echo "  make publish      - Publish to PyPI"
+
+install:
+	uv sync --all-extras
+
+test:
+	uv run pytest
+
+lint:
+	uv run ruff check .
+
+format:
+	uv run ruff format .
+	uv run ruff check --fix .
+
+type-check:
+	uv run ty check dotenvmodel
+
+clean:
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf .ruff_cache
+	rm -rf htmlcov
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name "*.pyc" -delete
+
+build: clean
+	uv build
+
+publish: build
+	uv publish