structguru 0.1.0__tar.gz → 0.2.0__tar.gz

structguru-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: make install
+
+      - name: Run quality gates
+        run: make check

structguru-0.2.0/.gitignore

@@ -0,0 +1,53 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store
+
+# Tool caches
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+
+# Coverage
+.coverage
+htmlcov/
+
+# Logs
+*.log
+/.agents/
+/AGENT.md
+/AGENTS.md
+/ARCHIVE_INDEX.md
+/CLAUDE.md
+/GEMINI.md
+/PROMPT_STRUCTGURU.md
+/.aiexclude
+
+# MkDocs
+/site/
+
+# Tooling caches & local scratch
+/.claude/
+/.uv-cache/
+
+# Unpacked standards archives & scratch / report files (not source)
+/ai-agents-standards-*/
+/errors.json
+/test_perf.py

structguru-0.2.0/.jetaprog/runConfigurations.json

@@ -0,0 +1,44 @@
+{
+    "version": 1,
+    "configurations": [
+        {
+            "id": "146f2f42-492f-73de-f05e-28bf6bf5a3f3",
+            "name": "structguru Run",
+            "type": "uv",
+            "isTemporary": false,
+            "settings": {
+                "type": "uv",
+                "command": "run",
+                "arguments": [],
+                "environment": {},
+                "workingDirectory": "/Users/apavlov/Projects/structguru"
+            },
+            "beforeLaunch": [],
+            "allowParallelRun": false,
+            "storeAsProjectFile": true,
+            "folderName": null
+        },
+        {
+            "id": "a7eba24c-3bf5-df16-8a48-0d6fd443ee84",
+            "name": "structguru Sync",
+            "type": "uv",
+            "isTemporary": true,
+            "settings": {
+                "type": "uv",
+                "command": "sync",
+                "arguments": [],
+                "environment": {},
+                "workingDirectory": "/Users/apavlov/Projects/structguru"
+            },
+            "beforeLaunch": [],
+            "allowParallelRun": false,
+            "storeAsProjectFile": true,
+            "folderName": null
+        }
+    ],
+    "activeConfigurationId": "a7eba24c-3bf5-df16-8a48-0d6fd443ee84",
+    "recentConfigurationIds": [
+        "a7eba24c-3bf5-df16-8a48-0d6fd443ee84",
+        "146f2f42-492f-73de-f05e-28bf6bf5a3f3"
+    ]
+}

structguru-0.2.0/Makefile

@@ -0,0 +1,40 @@
+.DEFAULT_GOAL := help
+
+.PHONY: help install test bench lint format typecheck check clean build publish-test publish
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-14s\033[0m %s\n", $$1, $$2}'
+
+install: ## Install dev dependencies and all integration extras
+	uv sync --all-extras
+
+test: ## Run tests
+	uv run python -m pytest --ignore=tests/benchmarks
+
+bench: ## Run benchmarks
+	uv run python -m pytest tests/benchmarks/ --benchmark-only
+
+lint: ## Run linter and format check
+	uv run ruff check .
+	uv run ruff format --check .
+
+format: ## Format code
+	uv run ruff format .
+
+typecheck: ## Run type checker (mypy strict)
+	uv run python -m mypy src/
+
+check: lint typecheck test ## Run lint + typecheck + tests
+
+clean: ## Remove build artifacts and caches
+	rm -rf dist/ build/ src/*.egg-info .mypy_cache .pytest_cache .ruff_cache
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+
+build: clean ## Build sdist and wheel
+	uv build
+
+publish-test: build ## Publish to TestPyPI
+	uv publish --publish-url https://test.pypi.org/legacy/
+
+publish: build ## Publish to PyPI
+	uv publish

{structguru-0.1.0 → structguru-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structguru
-Version: 0.1.0
+Version: 0.2.0
 Summary: A loguru-style ergonomic API for structlog
 Project-URL: Homepage, https://github.com/kidoz/structguru
 Project-URL: Repository, https://github.com/kidoz/structguru
@@ -29,7 +29,9 @@ Requires-Dist: celery>=5.0; extra == 'all'
 Requires-Dist: django>=4.0; extra == 'all'
 Requires-Dist: flask>=2.0; extra == 'all'
 Requires-Dist: grpcio>=1.50; extra == 'all'
+Requires-Dist: httpx>=0.20; extra == 'all'
 Requires-Dist: opentelemetry-api>=1.0; extra == 'all'
+Requires-Dist: requests>=2.0; extra == 'all'
 Requires-Dist: sentry-sdk>=1.0; extra == 'all'
 Requires-Dist: sqlalchemy>=2.0; extra == 'all'
 Provides-Extra: celery
@@ -40,8 +42,12 @@ Provides-Extra: flask
 Requires-Dist: flask>=2.0; extra == 'flask'
 Provides-Extra: grpc
 Requires-Dist: grpcio>=1.50; extra == 'grpc'
+Provides-Extra: httpx
+Requires-Dist: httpx>=0.20; extra == 'httpx'
 Provides-Extra: otel
 Requires-Dist: opentelemetry-api>=1.0; extra == 'otel'
+Provides-Extra: requests
+Requires-Dist: requests>=2.0; extra == 'requests'
 Provides-Extra: sentry
 Requires-Dist: sentry-sdk>=1.0; extra == 'sentry'
 Provides-Extra: sqlalchemy
@@ -133,12 +139,13 @@ logger.fatal("Alias for critical")
 
 ### Brace formatting
 
-Arguments serve double duty — they are used for `str.format` interpolation **and** included as structured fields:
+Arguments used in `str.format` placeholders are consumed by formatting (matching loguru behaviour). Extra kwargs that are **not** in any placeholder are forwarded as structured fields:
 
 ```python
-logger.info("User {user_id} logged in from {ip}", user_id=42, ip="10.0.0.1")
-# message: "User 42 logged in from 10.0.0.1"
-# user_id: 42, ip: "10.0.0.1"
+logger.info("User {user_id} logged in", user_id=42, ip="10.0.0.1")
+# message: "User 42 logged in"
+# ip: "10.0.0.1"  (extra kwarg kept as structured field)
+# user_id is consumed by formatting and not duplicated
 ```
 
 ### Bound context
@@ -224,11 +231,12 @@ configure_structlog(service="myapp", json_logs=False)
 Mask sensitive fields automatically:
 
 ```python
+import re
 from structguru import RedactingProcessor
 
 redactor = RedactingProcessor(
     sensitive_keys=frozenset({"password", "token", "ssn"}),
-    patterns=[r"\b\d{3}-\d{2}-\d{4}\b"],  # SSN pattern
+    patterns=[re.compile(r"\b\d{3}-\d{2}-\d{4}\b")],  # SSN pattern
     replacement="***",
 )
 # Add to your structlog processor chain
@@ -377,11 +385,17 @@ sentry = SentryProcessor(event_level=logging.ERROR, tag_keys=frozenset({"service
 - structlog >= 24.1.0
 - orjson >= 3.9.0
 
+## Documentation & Examples
+
+- **[Integrations Guide](docs/integrations.md)** — Detailed instructions for setting up frameworks.
+- **[Full-stack Example](examples/full_stack_fastapi/main.py)** — FastAPI + Celery + SQLAlchemy in action.
+
 ## Development
 
 ```bash
 uv sync
 uv run pytest
+make bench
 uv run ruff check .
 uv run mypy src/
 ```

{structguru-0.1.0 → structguru-0.2.0}/README.md

@@ -83,12 +83,13 @@ logger.fatal("Alias for critical")
 
 ### Brace formatting
 
-Arguments serve double duty — they are used for `str.format` interpolation **and** included as structured fields:
+Arguments used in `str.format` placeholders are consumed by formatting (matching loguru behaviour). Extra kwargs that are **not** in any placeholder are forwarded as structured fields:
 
 ```python
-logger.info("User {user_id} logged in from {ip}", user_id=42, ip="10.0.0.1")
-# message: "User 42 logged in from 10.0.0.1"
-# user_id: 42, ip: "10.0.0.1"
+logger.info("User {user_id} logged in", user_id=42, ip="10.0.0.1")
+# message: "User 42 logged in"
+# ip: "10.0.0.1"  (extra kwarg kept as structured field)
+# user_id is consumed by formatting and not duplicated
 ```
 
 ### Bound context
@@ -174,11 +175,12 @@ configure_structlog(service="myapp", json_logs=False)
 Mask sensitive fields automatically:
 
 ```python
+import re
 from structguru import RedactingProcessor
 
 redactor = RedactingProcessor(
     sensitive_keys=frozenset({"password", "token", "ssn"}),
-    patterns=[r"\b\d{3}-\d{2}-\d{4}\b"],  # SSN pattern
+    patterns=[re.compile(r"\b\d{3}-\d{2}-\d{4}\b")],  # SSN pattern
     replacement="***",
 )
 # Add to your structlog processor chain
@@ -327,11 +329,17 @@ sentry = SentryProcessor(event_level=logging.ERROR, tag_keys=frozenset({"service
 - structlog >= 24.1.0
 - orjson >= 3.9.0
 
+## Documentation & Examples
+
+- **[Integrations Guide](docs/integrations.md)** — Detailed instructions for setting up frameworks.
+- **[Full-stack Example](examples/full_stack_fastapi/main.py)** — FastAPI + Celery + SQLAlchemy in action.
+
 ## Development
 
 ```bash
 uv sync
 uv run pytest
+make bench
 uv run ruff check .
 uv run mypy src/
 ```

structguru-0.2.0/docs/api/config.md

@@ -0,0 +1,3 @@
+# API Reference: Configuration
+
+::: structguru.config

structguru-0.2.0/docs/api/core.md

@@ -0,0 +1,3 @@
+# API Reference: Core
+
+::: structguru.core

structguru-0.2.0/docs/api/exceptions.md

@@ -0,0 +1,3 @@
+# API Reference: Exceptions
+
+::: structguru.exceptions

structguru-0.2.0/docs/api/index.md

@@ -0,0 +1,12 @@
+# API Reference
+
+Welcome to the `structguru` API reference. 
+
+These pages are automatically generated from the source code docstrings using the `mkdocstrings` plugin. This ensures that the documentation is always up-to-date with the actual code implementation.
+
+Navigate through the sub-sections to explore the modules:
+
+*   **Core**: The main Loguru-style facade and logger implementation.
+*   **Configuration**: How to set up and configure structlog.
+*   **Processors**: Built-in processors for standardizing and enriching logs.
+*   **Integrations**: Adapters for popular frameworks like ASGI, Celery, Django, Flask, etc.

structguru-0.2.0/docs/api/integrations/asgi.md

@@ -0,0 +1,3 @@
+# ASGI Integration
+
+::: structguru.integrations.asgi

structguru-0.2.0/docs/api/integrations/celery.md

@@ -0,0 +1,3 @@
+# Celery Integration
+
+::: structguru.integrations.celery

structguru-0.2.0/docs/api/integrations/django.md

@@ -0,0 +1,3 @@
+# Django Integration
+
+::: structguru.integrations.django

structguru-0.2.0/docs/api/integrations/flask.md

@@ -0,0 +1,3 @@
+# Flask Integration
+
+::: structguru.integrations.flask

structguru-0.2.0/docs/api/integrations/grpc.md

@@ -0,0 +1,3 @@
+# gRPC Integration
+
+::: structguru.integrations.grpc

structguru-0.2.0/docs/api/integrations/httpx.md

@@ -0,0 +1,3 @@
+# HTTPX Integration
+
+::: structguru.integrations.httpx

structguru-0.2.0/docs/api/integrations/requests.md

@@ -0,0 +1,3 @@
+# Requests Integration
+
+::: structguru.integrations.requests

structguru-0.2.0/docs/api/integrations/sentry.md

@@ -0,0 +1,3 @@
+# Sentry Integration
+
+::: structguru.integrations.sentry

structguru-0.2.0/docs/api/integrations/sqlalchemy.md

@@ -0,0 +1,3 @@
+# SQLAlchemy Integration
+
+::: structguru.integrations.sqlalchemy

structguru-0.2.0/docs/api/integrations/stdlib.md

@@ -0,0 +1,3 @@
+# Standard Library Interception
+
+::: structguru.integrations.stdlib

structguru-0.2.0/docs/api/metrics.md

@@ -0,0 +1,3 @@
+# API Reference: Metrics
+
+::: structguru.metrics

structguru-0.2.0/docs/api/otel.md

@@ -0,0 +1,3 @@
+# API Reference: OpenTelemetry
+
+::: structguru.otel

structguru-0.2.0/docs/api/processors.md

@@ -0,0 +1,3 @@
+# API Reference: Processors
+
+::: structguru.processors

structguru-0.2.0/docs/api/queued.md

@@ -0,0 +1,3 @@
+# API Reference: Queued Logging
+
+::: structguru.queued

structguru-0.2.0/docs/api/redaction.md

@@ -0,0 +1,3 @@
+# API Reference: Redaction
+
+::: structguru.redaction

structguru-0.2.0/docs/api/routing.md

@@ -0,0 +1,3 @@
+# API Reference: Routing
+
+::: structguru.routing

structguru-0.2.0/docs/api/sampling.md

@@ -0,0 +1,3 @@
+# API Reference: Sampling
+
+::: structguru.sampling