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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for beautiful_oops-0.1.6.tar.gz
Algorithm Hash digest
SHA256 7209cbebadc157de46fdcb3a0c334af3aca75ba1ad65c2a7003d6e72c0c043ad
MD5 31bb342584967b130e31272c7e62c2c8
BLAKE2b-256 5472739641a04f6c617552e61ac73f4978cc505460b6dc03a5324b5102ddd530

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for beautiful_oops-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 66e975ca960d685b7bfc4f26909063fe309510d8b04d1eac6e4e507e50792ae5
MD5 9bacf4c271ee4de2220185205881709a
BLAKE2b-256 38a3382442d9c0ac7a3b8a85ea7689770a0b8b2914fce03d38b61da101883b0b

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