Skip to main content

A gentle, story-driven supervision and recovery framework for Python — because every error deserves a story.

Project description

🌿 Beautiful Oops

Because every error deserves a graceful story.

Beautiful Oops is a lightweight adventure-style supervision and recovery framework for Python.
It turns error handling into storytelling — each Moment can fail, retry, or succeed,
and all outcomes are recorded in a StoryBook.

✨ Features

  • 🪄 @oops_moment decorator for automatic retry / timeout / rollback
  • 🧙‍♀️ Elf & Hero – pluggable decision-makers for handling Oops
  • 📖 StoryBook Plugin – records every success and failure
  • 🔁 Backoff Policy – exponential with jitter
  • ⚙️ Plugin Architecture – easy to extend (logging, monitoring, circuit-breaker)
  • 🧩 Works in both sync and async modes

🚀 Quickstart

from beautiful_oops import oops_moment, Adventure, StorybookPlugin

@oops_moment(chapter="Chapter I", stage="decode_scroll")
def decode_scroll():
    return "ancient wisdom"

adv = Adventure(name="demo", plugins=[StorybookPlugin()])
with Adventure.auto(adv):
    print("Scroll:", decode_scroll())

🧠 Philosophy

⚡ Resilience is not about avoiding errors, but about facing them gracefully.

Adventure builds the story, Elf gives advice, Hero decides, StoryBook remembers.

🌌 Roadmap

🧩 Short-term (v0.2.x)

  • Fallback Plugin
  • Circuit Breaker Plugin
  • Sink System (Console / File / Prometheus / Loki)

🤖 Mid-term (v0.3–0.5)

  • Agent-based Error Decision Engine
    – let an intelligent agent decide whether to retry, ignore, or fallback

🕊️ Long-term (v1.0)

  • Visual Dashboard (Adventure Timeline)
  • Community Plugin Ecosystem

🧪 Testing & CI

pip install -e .[dev]
pytest -q
ruff check .
mypy beautiful_oops

or

uv run --extra dev pytest

MIT License © 2025 Sean Liu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beautiful_oops-0.1.8.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beautiful_oops-0.1.8-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

Details for the file beautiful_oops-0.1.8.tar.gz.

File metadata

  • Download URL: beautiful_oops-0.1.8.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.2

File hashes

Hashes for beautiful_oops-0.1.8.tar.gz
Algorithm Hash digest
SHA256 af185bfde3b61778807913bbecc5caf2d9e111edeba1b80f1c48495db1fb47a5
MD5 79f95cdebecaa37d9fb93f6b0ca2427a
BLAKE2b-256 68abab9ff02b71362eca00e8537a5c00a7764ff05c2a647a74565e8792e020bc

See more details on using hashes here.

File details

Details for the file beautiful_oops-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for beautiful_oops-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5b07b902293436146dded87798da41981418fcddec0057169001c5a43a1e6dc1
MD5 556e3fdfca8f255a60f07024a49a7ec6
BLAKE2b-256 d2a76d781682b7e55dcbd7920b1b1ca5736183187c2d4bf96854abdc77c51fb8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page