PyPI - raven-logger - Versions diffs - 1.0.0__tar.gz - Mend

raven-logger 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

raven_logger-1.0.0/LICENSE +21 -0
raven_logger-1.0.0/PKG-INFO +117 -0
raven_logger-1.0.0/README.md +93 -0
raven_logger-1.0.0/pyproject.toml +37 -0
raven_logger-1.0.0/raven_logger.egg-info/PKG-INFO +117 -0
raven_logger-1.0.0/raven_logger.egg-info/SOURCES.txt +8 -0
raven_logger-1.0.0/raven_logger.egg-info/dependency_links.txt +1 -0
raven_logger-1.0.0/raven_logger.egg-info/top_level.txt +1 -0
raven_logger-1.0.0/raven_sdk/__init__.py +94 -0
raven_logger-1.0.0/setup.cfg +4 -0

raven_logger-1.0.0/LICENSE ADDED Viewed

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

raven_logger-1.0.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: raven-logger
+Version: 1.0.0
+Summary: Application logging SDK for raven-log contract compliance — structured, validated JSON logs
+Author-email: Giggso <m.abbasi@giggso.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/giggso/raven-sdk
+Project-URL: Issues, https://github.com/giggso/raven-sdk/issues
+Keywords: logging,observability,structured-logging,raven,tracing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+# raven-sdk
+Application logging SDK for **raven-log contract compliance** — emit validated, structured JSON records from any Python service.
+## Install
+```bash
+pip install raven-sdk
+```
+## Quick start
+```python
+from raven_sdk import raven_log, new_trace_id, new_span_id
+trace = new_trace_id()
+raven_log(
+    level="INFO",
+    criticality="P3",
+    message="User signed in",
+    service="auth-service",
+    env="prod",
+    principal="user:42",
+    project="my-app",
+    trace_id=trace,
+)
+```
+Output (one JSON line to stdout):
+```json
+{
+  "schema_version": "1",
+  "timestamp": "2026-06-22T12:00:00.000000+00:00",
+  "level": "INFO",
+  "criticality": "P3",
+  "service": "auth-service",
+  "env": "prod",
+  "trace_id": "550e8400-e29b-41d4-a716-446655440000",
+  "span_id": "a1b2c3d4",
+  "principal": "user:42",
+  "error_code": "",
+  "message": "User signed in",
+  "context": {},
+  "sample_payload": "",
+  "project": "my-app"
+}
+```
+## API
+### `raven_log(...) -> dict`
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| `level` | `"ERROR"` \| `"WARN"` \| `"INFO"` \| `"DEBUG"` | ✓ | Log level |
+| `criticality` | `"P1"` \| `"P2"` \| `"P3"` \| `"P4"` | ✓ | Business criticality |
+| `message` | `str` | ✓ | Human-readable description |
+| `service` | `str` | ✓ | Emitting service name |
+| `env` | `"prod"` \| `"staging"` \| `"dev"` | ✓ | Deployment environment |
+| `principal` | `str` | ✓ | Acting identity (e.g. `"user:42"`) |
+| `project` | `str` | ✓ | Project/team identifier |
+| `error_code` | `str` | Required for `ERROR`/`WARN` | Machine-readable error code |
+| `trace_id` | `str` | — | Distributed trace ID (auto-generated if omitted) |
+| `span_id` | `str` | — | Span ID (auto-generated if omitted) |
+| `context` | `dict` | — | Arbitrary structured context |
+| `sample_payload` | `str` | — | Redacted payload snippet |
+Returns the emitted record as a `dict`.
+### `new_trace_id() -> str`
+Generates a UUID v4 trace ID for use at service boundaries.
+### `new_span_id() -> str`
+Generates an 8-character span ID for operations within a trace.
+## Custom emitter (Kafka, etc.)
+Pass `_emit` to replace the default stdout writer:
+```python
+def kafka_emit(record: dict) -> None:
+    producer.send("logs", json.dumps(record).encode())
+raven_log(..., _emit=kafka_emit)
+```
+## License
+MIT © Giggso

raven_logger-1.0.0/README.md ADDED Viewed

@@ -0,0 +1,93 @@
+# raven-sdk
+Application logging SDK for **raven-log contract compliance** — emit validated, structured JSON records from any Python service.
+## Install
+```bash
+pip install raven-sdk
+```
+## Quick start
+```python
+from raven_sdk import raven_log, new_trace_id, new_span_id
+trace = new_trace_id()
+raven_log(
+    level="INFO",
+    criticality="P3",
+    message="User signed in",
+    service="auth-service",
+    env="prod",
+    principal="user:42",
+    project="my-app",
+    trace_id=trace,
+)
+```
+Output (one JSON line to stdout):
+```json
+{
+  "schema_version": "1",
+  "timestamp": "2026-06-22T12:00:00.000000+00:00",
+  "level": "INFO",
+  "criticality": "P3",
+  "service": "auth-service",
+  "env": "prod",
+  "trace_id": "550e8400-e29b-41d4-a716-446655440000",
+  "span_id": "a1b2c3d4",
+  "principal": "user:42",
+  "error_code": "",
+  "message": "User signed in",
+  "context": {},
+  "sample_payload": "",
+  "project": "my-app"
+}
+```
+## API
+### `raven_log(...) -> dict`
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| `level` | `"ERROR"` \| `"WARN"` \| `"INFO"` \| `"DEBUG"` | ✓ | Log level |
+| `criticality` | `"P1"` \| `"P2"` \| `"P3"` \| `"P4"` | ✓ | Business criticality |
+| `message` | `str` | ✓ | Human-readable description |
+| `service` | `str` | ✓ | Emitting service name |
+| `env` | `"prod"` \| `"staging"` \| `"dev"` | ✓ | Deployment environment |
+| `principal` | `str` | ✓ | Acting identity (e.g. `"user:42"`) |
+| `project` | `str` | ✓ | Project/team identifier |
+| `error_code` | `str` | Required for `ERROR`/`WARN` | Machine-readable error code |
+| `trace_id` | `str` | — | Distributed trace ID (auto-generated if omitted) |
+| `span_id` | `str` | — | Span ID (auto-generated if omitted) |
+| `context` | `dict` | — | Arbitrary structured context |
+| `sample_payload` | `str` | — | Redacted payload snippet |
+Returns the emitted record as a `dict`.
+### `new_trace_id() -> str`
+Generates a UUID v4 trace ID for use at service boundaries.
+### `new_span_id() -> str`
+Generates an 8-character span ID for operations within a trace.
+## Custom emitter (Kafka, etc.)
+Pass `_emit` to replace the default stdout writer:
+```python
+def kafka_emit(record: dict) -> None:
+    producer.send("logs", json.dumps(record).encode())
+raven_log(..., _emit=kafka_emit)
+```
+## License
+MIT © Giggso

raven_logger-1.0.0/pyproject.toml ADDED Viewed

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "raven-logger"
+version = "1.0.0"
+description = "Application logging SDK for raven-log contract compliance — structured, validated JSON logs"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+  { name = "Giggso", email = "m.abbasi@giggso.com" }
+]
+keywords = ["logging", "observability", "structured-logging", "raven", "tracing"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: System :: Logging",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.8"
+dependencies = []
+[project.urls]
+Homepage = "https://github.com/giggso/raven-sdk"
+Issues = "https://github.com/giggso/raven-sdk/issues"
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["raven_sdk*"]

raven_logger-1.0.0/raven_logger.egg-info/PKG-INFO ADDED Viewed

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: raven-logger
+Version: 1.0.0
+Summary: Application logging SDK for raven-log contract compliance — structured, validated JSON logs
+Author-email: Giggso <m.abbasi@giggso.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/giggso/raven-sdk
+Project-URL: Issues, https://github.com/giggso/raven-sdk/issues
+Keywords: logging,observability,structured-logging,raven,tracing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+# raven-sdk
+Application logging SDK for **raven-log contract compliance** — emit validated, structured JSON records from any Python service.
+## Install
+```bash
+pip install raven-sdk
+```
+## Quick start
+```python
+from raven_sdk import raven_log, new_trace_id, new_span_id
+trace = new_trace_id()
+raven_log(
+    level="INFO",
+    criticality="P3",
+    message="User signed in",
+    service="auth-service",
+    env="prod",
+    principal="user:42",
+    project="my-app",
+    trace_id=trace,
+)
+```
+Output (one JSON line to stdout):
+```json
+{
+  "schema_version": "1",
+  "timestamp": "2026-06-22T12:00:00.000000+00:00",
+  "level": "INFO",
+  "criticality": "P3",
+  "service": "auth-service",
+  "env": "prod",
+  "trace_id": "550e8400-e29b-41d4-a716-446655440000",
+  "span_id": "a1b2c3d4",
+  "principal": "user:42",
+  "error_code": "",
+  "message": "User signed in",
+  "context": {},
+  "sample_payload": "",
+  "project": "my-app"
+}
+```
+## API
+### `raven_log(...) -> dict`
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| `level` | `"ERROR"` \| `"WARN"` \| `"INFO"` \| `"DEBUG"` | ✓ | Log level |
+| `criticality` | `"P1"` \| `"P2"` \| `"P3"` \| `"P4"` | ✓ | Business criticality |
+| `message` | `str` | ✓ | Human-readable description |
+| `service` | `str` | ✓ | Emitting service name |
+| `env` | `"prod"` \| `"staging"` \| `"dev"` | ✓ | Deployment environment |
+| `principal` | `str` | ✓ | Acting identity (e.g. `"user:42"`) |
+| `project` | `str` | ✓ | Project/team identifier |
+| `error_code` | `str` | Required for `ERROR`/`WARN` | Machine-readable error code |
+| `trace_id` | `str` | — | Distributed trace ID (auto-generated if omitted) |
+| `span_id` | `str` | — | Span ID (auto-generated if omitted) |
+| `context` | `dict` | — | Arbitrary structured context |
+| `sample_payload` | `str` | — | Redacted payload snippet |
+Returns the emitted record as a `dict`.
+### `new_trace_id() -> str`
+Generates a UUID v4 trace ID for use at service boundaries.
+### `new_span_id() -> str`
+Generates an 8-character span ID for operations within a trace.
+## Custom emitter (Kafka, etc.)
+Pass `_emit` to replace the default stdout writer:
+```python
+def kafka_emit(record: dict) -> None:
+    producer.send("logs", json.dumps(record).encode())
+raven_log(..., _emit=kafka_emit)
+```
+## License
+MIT © Giggso

raven_logger-1.0.0/raven_logger.egg-info/SOURCES.txt ADDED Viewed

@@ -0,0 +1,8 @@
+LICENSE
+README.md
+pyproject.toml
+raven_logger.egg-info/PKG-INFO
+raven_logger.egg-info/SOURCES.txt
+raven_logger.egg-info/dependency_links.txt
+raven_logger.egg-info/top_level.txt
+raven_sdk/__init__.py

raven_logger-1.0.0/raven_logger.egg-info/dependency_links.txt ADDED Viewed

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

raven_logger-1.0.0/raven_logger.egg-info/top_level.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ raven_sdk

raven_logger-1.0.0/raven_sdk/__init__.py ADDED Viewed

@@ -0,0 +1,94 @@
+"""
+raven_sdk — Application logging SDK for raven-log contract compliance.
+Import in your application:
+    from raven_sdk import raven_log, new_trace_id, new_span_id
+Every call emits a validated, structured record to stdout (JSON).
+In production, replace _emit() with your Kafka producer.
+"""
+import json, sys, uuid, os
+from datetime import datetime, timezone
+from typing import Optional, Literal, Any
+__version__ = "1.0.0"
+SCHEMA_VERSION = "1"
+_VALID_LEVELS        = {"ERROR", "WARN", "INFO", "DEBUG"}
+_VALID_CRITICALITIES = {"P1", "P2", "P3", "P4"}
+_VALID_ENVS          = {"prod", "staging", "dev"}
+def new_trace_id() -> str:
+    """Generate a new trace ID at a service boundary."""
+    return str(uuid.uuid4())
+def new_span_id() -> str:
+    """Generate a new span ID for an operation within a trace."""
+    return str(uuid.uuid4())[:8]
+def raven_log(
+    level:          Literal["ERROR", "WARN", "INFO", "DEBUG"],
+    criticality:    Literal["P1", "P2", "P3", "P4"],
+    message:        str,
+    service:        str,
+    env:            Literal["prod", "staging", "dev"],
+    principal:      str,
+    project:        str,
+    error_code:     str = "",
+    trace_id:       Optional[str] = None,
+    span_id:        Optional[str] = None,
+    context:        Optional[dict] = None,
+    sample_payload: str = "",
+    _emit=None,
+) -> dict:
+    """
+    Emit one raven-log conformant structured record.
+    Raises ValueError if required fields are missing or invalid.
+    """
+    # ── Validation ──────────────────────────────────────────────────────────────
+    if level not in _VALID_LEVELS:
+        raise ValueError(f"raven_log: level '{level}' invalid — must be one of {_VALID_LEVELS}")
+    if criticality not in _VALID_CRITICALITIES:
+        raise ValueError(f"raven_log: criticality '{criticality}' invalid — must be one of {_VALID_CRITICALITIES}")
+    if env not in _VALID_ENVS:
+        raise ValueError(f"raven_log: env '{env}' invalid — must be one of {_VALID_ENVS}")
+    if level in ("ERROR", "WARN") and not error_code:
+        raise ValueError(f"raven_log: error_code is required when level is {level}")
+    if not service:
+        raise ValueError("raven_log: service is required")
+    if not principal:
+        raise ValueError("raven_log: principal is required")
+    if not project:
+        raise ValueError("raven_log: project is required")
+    # ── Build record ────────────────────────────────────────────────────────────
+    record = {
+        "schema_version": SCHEMA_VERSION,
+        "timestamp":      datetime.now(timezone.utc).isoformat(),
+        "level":          level,
+        "criticality":    criticality,
+        "service":        service,
+        "env":            env,
+        "trace_id":       trace_id or new_trace_id(),
+        "span_id":        span_id  or new_span_id(),
+        "principal":      principal,
+        "error_code":     error_code,
+        "message":        message,
+        "context":        context or {},
+        "sample_payload": sample_payload,
+        "project":        project,
+    }
+    # ── Emit ─────────────────────────────────────────────────────────────────────
+    emitter = _emit or _default_emit
+    emitter(record)
+    return record
+def _default_emit(record: dict) -> None:
+    """Default emitter: write one JSON line to stdout."""
+    print(json.dumps(record), flush=True)

raven_logger-1.0.0/setup.cfg ADDED Viewed

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build =
+tag_date = 0