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.7.tar.gz (20.5 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.7-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for beautiful_oops-0.1.7.tar.gz
Algorithm Hash digest
SHA256 a130e03b704bd471e3009971da1758d32a40862b90224d8b3131d23f25bf58cd
MD5 a62759c665a8cf97b604fbce9f2d3fda
BLAKE2b-256 34e3ff97634fb270d22dafb28fb22c8b2cf95baecf686bc4ed05cf28b21724a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for beautiful_oops-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b52361fd336b7e63b10af343302da5baad9491fe830f96c1037a80842083f414
MD5 b78d668c211b475901d24a9271033eb1
BLAKE2b-256 bcd8f1bc19b42a85d6344c93c6885ecbf8fc5af1c04910a26ff83384e3ddd676

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