confkit 2.0.0__tar.gz → 2.1.0__tar.gz

confkit-2.1.0/.github/workflows/docs.yml

@@ -0,0 +1,88 @@
+name: Docs
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+    types: [ opened, reopened, synchronize, closed ]
+  workflow_dispatch:
+
+permissions: read-all
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages-${{ github.ref_name }}"
+  cancel-in-progress: false
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write       # Required to allow pr-preview-action to push to `gh-pages`
+      pull-requests: write  # Required to allow pr-preview-action to add comments with the link in the PR
+      pages: write          # Required to upload-pages-artifact op master
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        if: github.event.action != 'closed'
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        if: github.event.action != 'closed'
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Setup Pages
+        if: github.event.action != 'closed'
+        uses: actions/configure-pages@v5
+
+      - name: Generate docs (pdoc + mkdocs)
+        if: github.event.action != 'closed'
+        env:
+          DOCS_BASE_URL: ${{ github.event_name == 'pull_request' && format('https://github.io{0}', github.event.number) || 'https://herogold.github.io/confkit' }}
+        run: |
+          uv sync --group docs
+          uv run pdoc confkit -o docs/api
+
+          # Replace all links to the production site with the PR preview URL for PRs, or leave them as-is for pushes to master
+          find docs/api -name "*.md" -type f -exec sed -i "s|https://herogold.github.io/confkit|$DOCS_BASE_URL|g" {} +
+
+          uv run mkdocs build -d site
+
+      # Only upload artifact if the push is on the master branch
+      - name: Upload artifact
+        if: github.ref == 'refs/heads/master'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      # Deploy the PR preview on open/sync/reopen; remove it when the PR is closed.
+      # pr-preview-action defaults to `action: auto`, which detects the `closed`
+      # event and deletes the preview directory from gh-pages.
+      - name: Deploy PR Preview
+        if: github.event_name == 'pull_request'
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: site
+          preview-branch: gh-pages
+          umbrella-dir: pr-previews
+
+  deploy:
+    if: github.ref == 'refs/heads/master'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-docs
+    permissions:
+      pages: write          # Required to update the Pages site
+      id-token: write       # Required to OIDC verification of the deployment
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

confkit-2.1.0/.github/workflows/gitleaks.yml

@@ -0,0 +1,28 @@
+name: Gitleaks
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  workflow_call:
+
+concurrency: gitleaks-${{ github.ref }}
+
+permissions:
+  contents: read
+
+jobs:
+  gitleaks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run Gitleaks
+        uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

confkit-2.1.0/.github/workflows/lint-public.yml

@@ -0,0 +1,70 @@
+name: Type Check Public API
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: lint-public-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name : Install dependencies
+        run: uv sync --dev
+
+  lint:
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - tool: ruff
+            args: "check ./examples"
+          - tool: ty
+            args: "check ./examples --ignore no-matching-overload"
+          - tool: pyrefly
+            args: "check ./examples"
+          - tool: zuban
+            args: "check ./examples"
+          - tool: mypy
+            args: "./examples"
+          - tool: pyright
+            args: "./examples"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv (Should be cached from setup job)
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Cache lint results
+        uses: actions/cache@v4
+        with:
+          path: .lint_cache
+          key: ${{ runner.os }}-lint-${{matrix.tool}}-${{ hashFiles('**/tests/**/*.py', 'src/**') }}
+          restore-keys: |
+            ${{ runner.os }}-lint-${{matrix.tool}}
+
+      - name: Run type checking - ${{matrix.tool}}
+        run: uv add ${{matrix.tool}} && uv run ${{matrix.tool}} ${{matrix.args}}

confkit-2.1.0/.github/workflows/lint.yml

@@ -0,0 +1,66 @@
+name: Lint & Type Check
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  workflow_call:
+
+concurrency: lint-${{ github.ref }}
+
+permissions:
+  contents: read
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name : Install dependencies
+        run: uv sync --dev
+
+  lint-and-check:
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - tool: ruff
+            args: "check ."
+            cache_path: ".ruff_cache"
+          - tool: ty
+            args: "check . --ignore no-matching-overload"
+            cache_path: ".ty_cache"
+          - tool: undersort
+            args: ". --check"
+            cache_path: ".undersort_cache"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Cache lint results
+        id: cache-lint
+        uses: actions/cache@v4
+        with:
+          path: .lint_cache
+          key: ${{ runner.os }}-${{ matrix.tool }}-${{ hashFiles('**/tests/**/*.py', 'src/**') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.tool }}-
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Run ${{ matrix.tool }}
+        run: uv add ${{ matrix.tool }} && uv run ${{ matrix.tool }} ${{ matrix.args }}

{confkit-2.0.0 → confkit-2.1.0}/.github/workflows/test.yml

@@ -30,8 +30,6 @@ jobs:
         with:
           path: .pytest_cache
           key: ${{ runner.os }}-pytest-${{ matrix.python-version }}-${{ hashFiles('**/tests/**/*.py', 'src/**') }}
-          restore-keys: |
-            ${{ runner.os }}-pytest-${{ matrix.python-version }}-
 
       - name: Install uv
         if: steps.cache-pytest.outputs.cache-hit != 'true'

{confkit-2.0.0 → confkit-2.1.0}/.gitignore

@@ -206,5 +206,4 @@ __marimo__/
 # Custom ignores
 *test.ini
 .secrets
-uv.lock
 docs/api/

{confkit-2.0.0 → confkit-2.1.0}/.pre-commit-config.yaml

@@ -49,6 +49,12 @@ repos:
       - id: debug-statements
         files: ^src/.*\.py$
 
+  # Security scanning
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.24.2
+    hooks:
+      - id: gitleaks
+
   # Validate packaging metadata early
   - repo: https://github.com/abravalheri/validate-pyproject
     rev: v0.24.1
@@ -82,6 +88,12 @@ repos:
         types: [python]
         pass_filenames: false
         always_run: true
+      - id: undersort
+        name: undersort
+        entry: undersort
+        language: python
+        types: [python]
+        additional_dependencies: ["undersort"]
 
   # Spell checking (global)
   - repo: https://github.com/shellcheck-py/shellcheck-py

{confkit-2.0.0 → confkit-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: confkit
-Version: 2.0.0
+Version: 2.1.0
 Summary: Lightweight and Easy to use configuration manager for Python projects
 Author: HEROgold
 Requires-Python: >=3.11

{confkit-2.0.0 → confkit-2.1.0}/examples/file_change_event.py

@@ -3,6 +3,7 @@
 Basic example showing how to use the on_file_change() hook to detect changes in the configuration file.
 Copy of basic.py
 """
+from typing import Literal, Any
 from random import randint
 
 from configparser import ConfigParser
@@ -17,13 +18,13 @@ Config.set_file(Path("config.ini"))
 Config.write_on_edit = True
 
 
-def on_api_change(origin: str, old: str, new: str) -> None:
+def on_api_change(origin: Literal["get", "set"], old: str | None, new: str | None) -> None:
     if origin == "get":
         print(f"[on_file_change] API key accessed. Current value: '{new}' (previous: '{old}')")
     elif origin == "set":
         print(f"[on_file_change] API key changed from '{old}' to '{new}'. Reconnecting to API...")
 
-def print_change(origin, old, new) -> None:
+def print_change(origin: Literal["get", "set"], old: bool, new: bool) -> None:
     print(f"Configuration file has changed! {origin=} {old=} {new=}")
 
 class AppConfig:
@@ -44,8 +45,8 @@ class AppConfig:
     # Optional string (can be empty)
     api_key = Config("", optional=True)
 
-    debug.on_file_change = print_change
-    api_key.on_file_change = on_api_change
+    debug.on_file_change = print_change  # type: ignore[method-assign]
+    api_key.on_file_change = on_api_change  # type: ignore[method-assign]
 
 
 if __name__ == "__main__":
@@ -60,4 +61,4 @@ if __name__ == "__main__":
     # This automatically saves to config.ini when write_on_edit is True
     cfg.debug = not cfg.debug
     # Set the API key
-    cfg.api_key = randint(100000, 999999)
+    cfg.api_key = "my-secret-api"

{confkit-2.0.0 → confkit-2.1.0}/examples/url_example.py

@@ -1,4 +1,5 @@
 """Example of using a custom URL data type with confkit."""
+from typing_extensions import override
 from pathlib import Path
 from configparser import ConfigParser
 
@@ -10,6 +11,7 @@ Config.set_file(Path("config.ini"))
 class URL(BaseDataType[ParseResult]):
     """A config value that is a URL."""
 
+    @override
     def convert(self, value: str) -> ParseResult:
         """Convert a string value to a URL."""
         return urlparse(value)
@@ -29,6 +31,6 @@ if __name__ == "__main__":
     print("Docs path:", app_config.docs.path)
 
     # You can also assign a new URL string
-    app_config.homepage = "https://example.com/newpage"
+    app_config.homepage = urlparse("https://example.com/newpage")
     print("Updated homepage:", app_config.homepage)
     print("Updated homepage netloc:", app_config.homepage.netloc)

{confkit-2.0.0 → confkit-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "confkit"
-version = "2.0.0"
+version = "2.1.0"
 description = "Lightweight and Easy to use configuration manager for Python projects"
 readme = "README.md"
 authors = [
@@ -56,3 +56,7 @@ exclude = ["tests"]
 
 [tool.ty.rules]
 invalid-assignment = "ignore"
+
+[tool.undersort]
+order = ["public", "protected", "private"]
+method_type_order = ["instance", "class", "static"]