papyra 0.1.0__tar.gz

papyra-0.1.0/.gitignore

@@ -0,0 +1,31 @@
+# folders
+*.egg-info/
+.hypothesis/
+.idea/
+.mypy_cache/
+.pytest_cache/
+.scannerwork/
+.tox/
+.venv/
+.vscode/
+__pycache__/
+virtualenv/
+build/
+dist/
+node_modules/
+results/
+site/
+site_lang/
+target/
+
+# files
+**/*.so
+**/*.sqlite
+*.iml
+**/*_test*
+.DS_Store
+.coverage
+.coverage.*
+.python-version
+coverage.*
+example.sqlite

papyra-0.1.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright © 2025, Tiago Silva. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

papyra-0.1.0/PKG-INFO

@@ -0,0 +1,305 @@
+Metadata-Version: 2.4
+Name: papyra
+Version: 0.1.0
+Summary: The async actor model you didn't know you needed
+Project-URL: Homepage, https://github.com/dymmond/papyra
+Project-URL: Documentation, https://papyra.dymmond.com
+Project-URL: Changelog, https://papyra.dymmond.com/release-notes/
+Project-URL: Funding, https://github.com/sponsors/tarsil
+Project-URL: Source, https://github.com/dymmond/papyra
+Author-email: Tiago Silva <tiago@tarsild.io>
+License-File: LICENSE
+Keywords: actor,actor-system,asgi,async,concurrency,distributed-systems,papyra
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AnyIO
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: anyio>=4.12.0
+Requires-Dist: sayer>=0.7.5
+Provides-Extra: redis
+Requires-Dist: redis>=7.1.0; extra == 'redis'
+Provides-Extra: testing
+Requires-Dist: autoflake<3.0.0,>=2.0.2; extra == 'testing'
+Requires-Dist: black<25.0,==24.1.1; extra == 'testing'
+Requires-Dist: fastapi; extra == 'testing'
+Requires-Dist: httpx; extra == 'testing'
+Requires-Dist: ipdb; extra == 'testing'
+Requires-Dist: isort<6.0.0,>=5.12.0; extra == 'testing'
+Requires-Dist: pytest-cov<5.0.0,>=4.0.0; extra == 'testing'
+Requires-Dist: pytest<9.0.0,>=7.2.2; extra == 'testing'
+Requires-Dist: ravyn; extra == 'testing'
+Description-Content-Type: text/markdown
+
+# Papyra
+
+<p align="center">
+  <a href="https://papyra.dymmond.com"><img src="https://res.cloudinary.com/dymmond/image/upload/v1768380322/Papyra/logo_wgunlg.png" alt='Papyra'></a>
+</p>
+
+<p align="center">
+    <em>Durable persistence, retention and compaction for actor systems</em>
+</p>
+
+<p align="center">
+<a href="https://github.com/dymmond/papyra/actions/workflows/test-suite.yml/badge.svg?event=push&branch=main" target="_blank">
+    <img src="https://github.com/dymmond/papyra/actions/workflows/test-suite.yml/badge.svg?event=push&branch=main" alt="Test Suite">
+</a>
+
+<a href="https://pypi.org/project/papyra" target="_blank">
+    <img src="https://img.shields.io/pypi/v/papyra?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+
+<a href="https://pypi.org/project/papyra" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/papyra.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+**Documentation**: [https://papyra.dymmond.com](https://papyra.dymmond.com) 📚
+
+**Source Code**: [https://github.com/dymmond/papyra](https://github.com/dymmond/papyra)
+
+**The official supported version is always the latest released**.
+
+---
+
+**Durable persistence, retention, recovery, and observability for actor systems.**
+
+Papyra is a production-grade persistence layer designed specifically for **actor-based runtimes**.
+It provides **durable system history**, **audits**, **dead-letter tracking**, **retention + compaction**,
+**startup health checks**, **recovery orchestration**, and **operational tooling**.
+
+> Papyra is not an actor framework.
+> It's the **persistence and observability backbone** that makes an actor system operationally safe.
+
+---
+
+## Why Papyra?
+
+Actor systems are excellent at concurrency and fault isolation, but production operators eventually need:
+
+- A durable history of lifecycle events (start/stop/crash/restart)
+- Audit snapshots for “what's running and what's broken?”
+- Dead letters for undeliverable messages
+- Retention to prevent unbounded growth
+- Compaction to physically reclaim disk space
+- Startup checks and deterministic recovery
+- Metrics for observability
+- CLI tools for real-world operations
+
+Papyra solves this **explicitly** and safely.
+
+---
+
+## Features
+
+### 🧱 Persistence backends
+
+- **JSON NDJSON file** backend (simple, readable, portable)
+- **Rotating files** backend (bounded disk usage)
+- **Redis Streams** backend (production, distributed, consumer-groups)
+- **In-memory** backend (tests, ephemeral)
+
+### ♻️ Retention & compaction
+
+- Record-count, age, and size-based retention
+- Explicit **physical compaction / vacuum**
+- Crash-safe atomic rewrite semantics where applicable
+
+### 🩺 Health, startup checks & recovery
+
+- Scan for corruption / anomalies
+- Recovery modes: **IGNORE / REPAIR / QUARANTINE**
+- Startup orchestration to guarantee a clean persistence layer before actors start
+
+### 📊 Metrics & integration
+
+- Backend metrics (writes, errors, scans, recoveries, compactions)
+- CLI metrics output
+- Optional OpenTelemetry integration
+
+### 🛠️ CLI
+
+- `persistence scan | recover | compact | inspect | startup-check`
+- `doctor run`
+- `inspect events | audits | dead-letters | summary`
+- `metrics …`
+
+---
+
+## Installation
+
+```bash
+pip install papyra
+```
+
+Optional extras:
+
+```bash
+pip install papyra[redis]
+```
+
+---
+
+## ActorSystem + Papyra: the mental model
+
+An `ActorSystem` emits **observable facts** while it runs:
+
+- **Events**: lifecycle transitions (started, stopped, crashed, restarted)
+- **Audits**: point-in-time health snapshots (counts, registry status, dead letters)
+- **Dead letters**: messages that couldn't be delivered
+
+Papyra persists these facts using the configured backend.
+
+A key guarantee: **startup checks happen before any actor is allowed to run**.
+If the persistence layer is corrupted and startup mode is strict, `ActorSystem.start()` fails.
+
+---
+
+## Quickstart (with ActorSystem)
+
+### 1) Pick a persistence backend
+
+#### JSON file backend
+
+```python
+from papyra.persistence.json import JsonFilePersistence
+
+persistence = JsonFilePersistence("./papyra.ndjson")
+```
+
+#### Redis Streams backend
+
+```python
+from papyra.persistence.backends.redis import RedisStreamsConfig, RedisStreamsPersistence
+
+persistence = RedisStreamsPersistence(
+    RedisStreamsConfig(url="redis://localhost:6379/0", prefix="papyra", system_id="local")
+)
+```
+
+### 2) Start the ActorSystem with startup checks
+
+```python
+from papyra.system import ActorSystem
+from papyra.persistence.startup import PersistenceStartupConfig, PersistenceStartupMode
+from papyra.persistence.models import PersistenceRecoveryConfig, PersistenceRecoveryMode
+
+system = ActorSystem(
+    persistence=persistence,
+    # Ensure the persistence layer is clean *before* any actor starts
+    persistence_startup=PersistenceStartupConfig(
+        mode=PersistenceStartupMode.RECOVER,
+        recovery=PersistenceRecoveryConfig(mode=PersistenceRecoveryMode.REPAIR),
+    ),
+)
+
+await system.start()
+```
+
+- `fail_on_anomaly` → start fails if corruption is detected
+- `recover` → attempt recovery, then require a clean post-scan
+- `ignore` / `scan_only` → don't fail startup
+
+### 3) Spawn actors after the system starts
+
+```python
+from papyra.actor import Actor
+
+class Echo(Actor):
+    async def receive(self, message):
+        return message
+
+ref = system.spawn(Echo, name="echo")
+```
+
+### 4) Shut down cleanly
+
+```python
+await system.aclose()
+```
+
+---
+
+## Operational CLI
+
+### Health check (Doctor)
+
+```bash
+papyra doctor run
+```
+
+Fail hard if there are anomalies:
+
+```bash
+papyra doctor run --mode fail_on_anomaly
+```
+
+Attempt recovery:
+
+```bash
+papyra doctor run --mode recover --recovery-mode repair
+```
+
+### Persistence maintenance
+
+Scan:
+
+```bash
+papyra persistence scan --path ./papyra.ndjson
+```
+
+Recover:
+
+```bash
+papyra persistence recover --mode repair --path ./papyra.ndjson
+```
+
+Compact:
+
+```bash
+papyra persistence compact --path ./papyra.ndjson
+```
+
+Inspect summary:
+
+```bash
+papyra persistence inspect --path ./papyra.ndjson --show-metrics
+```
+
+---
+
+## Documentation
+
+The full documentation covers:
+
+- Core concepts and actor lifecycle observability
+- All persistence backends (JSON, rotation, Redis, memory)
+- Retention and compaction strategies
+- Failure scenarios and recovery playbooks
+- Startup guarantees
+- Metrics + OpenTelemetry integration
+- Extending Papyra with custom backends

papyra-0.1.0/README.md

@@ -0,0 +1,251 @@
+# Papyra
+
+<p align="center">
+  <a href="https://papyra.dymmond.com"><img src="https://res.cloudinary.com/dymmond/image/upload/v1768380322/Papyra/logo_wgunlg.png" alt='Papyra'></a>
+</p>
+
+<p align="center">
+    <em>Durable persistence, retention and compaction for actor systems</em>
+</p>
+
+<p align="center">
+<a href="https://github.com/dymmond/papyra/actions/workflows/test-suite.yml/badge.svg?event=push&branch=main" target="_blank">
+    <img src="https://github.com/dymmond/papyra/actions/workflows/test-suite.yml/badge.svg?event=push&branch=main" alt="Test Suite">
+</a>
+
+<a href="https://pypi.org/project/papyra" target="_blank">
+    <img src="https://img.shields.io/pypi/v/papyra?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+
+<a href="https://pypi.org/project/papyra" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/papyra.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+**Documentation**: [https://papyra.dymmond.com](https://papyra.dymmond.com) 📚
+
+**Source Code**: [https://github.com/dymmond/papyra](https://github.com/dymmond/papyra)
+
+**The official supported version is always the latest released**.
+
+---
+
+**Durable persistence, retention, recovery, and observability for actor systems.**
+
+Papyra is a production-grade persistence layer designed specifically for **actor-based runtimes**.
+It provides **durable system history**, **audits**, **dead-letter tracking**, **retention + compaction**,
+**startup health checks**, **recovery orchestration**, and **operational tooling**.
+
+> Papyra is not an actor framework.
+> It's the **persistence and observability backbone** that makes an actor system operationally safe.
+
+---
+
+## Why Papyra?
+
+Actor systems are excellent at concurrency and fault isolation, but production operators eventually need:
+
+- A durable history of lifecycle events (start/stop/crash/restart)
+- Audit snapshots for “what's running and what's broken?”
+- Dead letters for undeliverable messages
+- Retention to prevent unbounded growth
+- Compaction to physically reclaim disk space
+- Startup checks and deterministic recovery
+- Metrics for observability
+- CLI tools for real-world operations
+
+Papyra solves this **explicitly** and safely.
+
+---
+
+## Features
+
+### 🧱 Persistence backends
+
+- **JSON NDJSON file** backend (simple, readable, portable)
+- **Rotating files** backend (bounded disk usage)
+- **Redis Streams** backend (production, distributed, consumer-groups)
+- **In-memory** backend (tests, ephemeral)
+
+### ♻️ Retention & compaction
+
+- Record-count, age, and size-based retention
+- Explicit **physical compaction / vacuum**
+- Crash-safe atomic rewrite semantics where applicable
+
+### 🩺 Health, startup checks & recovery
+
+- Scan for corruption / anomalies
+- Recovery modes: **IGNORE / REPAIR / QUARANTINE**
+- Startup orchestration to guarantee a clean persistence layer before actors start
+
+### 📊 Metrics & integration
+
+- Backend metrics (writes, errors, scans, recoveries, compactions)
+- CLI metrics output
+- Optional OpenTelemetry integration
+
+### 🛠️ CLI
+
+- `persistence scan | recover | compact | inspect | startup-check`
+- `doctor run`
+- `inspect events | audits | dead-letters | summary`
+- `metrics …`
+
+---
+
+## Installation
+
+```bash
+pip install papyra
+```
+
+Optional extras:
+
+```bash
+pip install papyra[redis]
+```
+
+---
+
+## ActorSystem + Papyra: the mental model
+
+An `ActorSystem` emits **observable facts** while it runs:
+
+- **Events**: lifecycle transitions (started, stopped, crashed, restarted)
+- **Audits**: point-in-time health snapshots (counts, registry status, dead letters)
+- **Dead letters**: messages that couldn't be delivered
+
+Papyra persists these facts using the configured backend.
+
+A key guarantee: **startup checks happen before any actor is allowed to run**.
+If the persistence layer is corrupted and startup mode is strict, `ActorSystem.start()` fails.
+
+---
+
+## Quickstart (with ActorSystem)
+
+### 1) Pick a persistence backend
+
+#### JSON file backend
+
+```python
+from papyra.persistence.json import JsonFilePersistence
+
+persistence = JsonFilePersistence("./papyra.ndjson")
+```
+
+#### Redis Streams backend
+
+```python
+from papyra.persistence.backends.redis import RedisStreamsConfig, RedisStreamsPersistence
+
+persistence = RedisStreamsPersistence(
+    RedisStreamsConfig(url="redis://localhost:6379/0", prefix="papyra", system_id="local")
+)
+```
+
+### 2) Start the ActorSystem with startup checks
+
+```python
+from papyra.system import ActorSystem
+from papyra.persistence.startup import PersistenceStartupConfig, PersistenceStartupMode
+from papyra.persistence.models import PersistenceRecoveryConfig, PersistenceRecoveryMode
+
+system = ActorSystem(
+    persistence=persistence,
+    # Ensure the persistence layer is clean *before* any actor starts
+    persistence_startup=PersistenceStartupConfig(
+        mode=PersistenceStartupMode.RECOVER,
+        recovery=PersistenceRecoveryConfig(mode=PersistenceRecoveryMode.REPAIR),
+    ),
+)
+
+await system.start()
+```
+
+- `fail_on_anomaly` → start fails if corruption is detected
+- `recover` → attempt recovery, then require a clean post-scan
+- `ignore` / `scan_only` → don't fail startup
+
+### 3) Spawn actors after the system starts
+
+```python
+from papyra.actor import Actor
+
+class Echo(Actor):
+    async def receive(self, message):
+        return message
+
+ref = system.spawn(Echo, name="echo")
+```
+
+### 4) Shut down cleanly
+
+```python
+await system.aclose()
+```
+
+---
+
+## Operational CLI
+
+### Health check (Doctor)
+
+```bash
+papyra doctor run
+```
+
+Fail hard if there are anomalies:
+
+```bash
+papyra doctor run --mode fail_on_anomaly
+```
+
+Attempt recovery:
+
+```bash
+papyra doctor run --mode recover --recovery-mode repair
+```
+
+### Persistence maintenance
+
+Scan:
+
+```bash
+papyra persistence scan --path ./papyra.ndjson
+```
+
+Recover:
+
+```bash
+papyra persistence recover --mode repair --path ./papyra.ndjson
+```
+
+Compact:
+
+```bash
+papyra persistence compact --path ./papyra.ndjson
+```
+
+Inspect summary:
+
+```bash
+papyra persistence inspect --path ./papyra.ndjson --show-metrics
+```
+
+---
+
+## Documentation
+
+The full documentation covers:
+
+- Core concepts and actor lifecycle observability
+- All persistence backends (JSON, rotation, Redis, memory)
+- Retention and compaction strategies
+- Failure scenarios and recovery playbooks
+- Startup guarantees
+- Metrics + OpenTelemetry integration
+- Extending Papyra with custom backends

papyra-0.1.0/papyra/__init__.py

@@ -0,0 +1,47 @@
+from typing import TYPE_CHECKING
+
+from .monkay import create_monkay
+
+__version__ = "0.1.0"
+
+if TYPE_CHECKING:
+    from ._envelope import DeadLetter
+    from .actor import Actor
+    from .audit import ActorInfo, AuditReport
+    from .conf import settings
+    from .conf.global_settings import Settings
+    from .context import ActorContext
+    from .exceptions import ActorStopped, AskTimeout, MailboxClosed, PapyraError
+    from .hooks import FailureInfo, SystemHooks
+    from .ref import ActorRef
+    from .supervision import Strategy, SupervisionPolicy
+    from .supervisor import SupervisorDecision
+    from .system import ActorSystem
+    from .typing import Receives, ReceivesAny
+
+
+__all__ = [
+    "Actor",
+    "ActorContext",
+    "ActorRef",
+    "ActorSystem",
+    "ActorInfo",
+    "AuditReport",
+    "PapyraError",
+    "ActorStopped",
+    "AskTimeout",
+    "MailboxClosed",
+    "Strategy",
+    "SupervisionPolicy",
+    "SupervisorDecision",
+    "DeadLetter",
+    "Receives",
+    "ReceivesAny",
+    "Settings",
+    "settings",
+    "SystemHooks",
+    "FailureInfo",
+]
+
+monkay = create_monkay(globals())
+del create_monkay