blob: 48f624e0f6f1a765de9fa5642511dcc6f9054c69 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
--- readme.rst.orig 2025-09-11 08:55:00 UTC
+++ readme.rst
@@ -0,0 +1,63 @@
+aiobreaker
+==========
+
+aiobreaker is a Python implementation of the Circuit Breaker pattern,
+described in Michael T. Nygard's book `Release It!`_.
+
+Circuit breakers exist to allow one subsystem to fail without destroying
+the entire system. This is done by wrapping dangerous operations
+(typically integration points) with a component that can circumvent
+calls when the system is not healthy.
+
+This project is a fork of pybreaker_ by Daniel Fernandes Martins that
+replaces tornado with native asyncio, originally so I could practice
+packaging and learn about that shiny new ``typing`` package.
+
+.. _`Release It!`: https://pragprog.com/titles/mnee2/release-it-second-edition/
+.. _pybreaker: https://github.com/danielfm/pybreaker
+
+Features
+--------
+
+- Configurable list of excluded exceptions (e.g. business exceptions)
+- Configurable failure threshold and reset timeout
+- Support for several event listeners per circuit breaker
+- Can guard generator functions
+- Functions and properties for easy monitoring and management
+- ``asyncio`` support
+- Optional redis backing
+- Synchronous and asynchronous event listeners
+
+Requirements
+------------
+
+All you need is ``python 3.6`` or higher.
+
+Installation
+------------
+
+To install, simply download from pypi:
+
+.. code:: bash
+
+ pip install aiobreaker
+
+Usage
+-----
+
+The first step is to create an instance of ``CircuitBreaker`` for each
+integration point you want to protect against.
+
+.. code:: python
+
+ from aiobreaker import CircuitBreaker
+
+ # Used in database integration points
+ db_breaker = CircuitBreaker(fail_max=5, reset_timeout=timedelta(seconds=60))
+
+ @db_breaker
+ async def outside_integration():
+ """Hits the api"""
+ ...
+
+At that point, go ahead and get familiar with the documentation.
|
