Skip to content

Hyx

Hyx

🧘‍♂️️ Lightweight fault tolerance primitives for your resilient and modern Python microservices

Package Version Downloads Supported Python Versions
Documentation Status Test Status Coverage

Hyx (/ˈhʌɪx/) is a set of well-known stability patterns that are commonly needed when you build microservice-based applications. Hyx is meant to be Hystrix (Java), resilience4j (Java) or Polly (C#) but for the Python world.

Note

This project is under active development and testing in production. Your feedback and help are highly appreciated!

Key Features

  • Implements five commonly used resiliency patterns with various configurations based on advice and experience of industry leaders (e.g. AWS, Google, Netflix)
  • Idiomatic Pythonic implementation based on decorators and context managers
  • AsyncIO Native Implementation
  • Built-in telemetry support for OpenTelemetry, Prometheus, and StatsD
  • Lightweight. Readable Codebase. High Test Coverage

Warning

At this stage, Hyx prioritizes speed of development over API stability. This is going to change once we implement main features and use cases.

Requirements

Installation

Hyx can be installed from PyPi:

pip install hyx

uv add hyx

Components

Here is a short overview of Hyx's components:

Component Problem Solution Implemented?
🔁 Retry Failures happen sometimes, but they self-recover after a short time Automatically retry operations on temporary failures ✅
💾 Cache
⚡️ Circuit Breaker When downstream microservices become overloaded, sending even more load only makes things worse Temporarily stop sending requests to failing microservices when error thresholds are exceeded. Then check if the pause helped them recover ✅
⏱ Timeout Sometimes operations take too long. We can't wait forever, and after a certain point success becomes unlikely Bound waiting to a reasonable amount of time ✅
🚰 Bulkhead Without limits, some code can consume too many resources, bringing down the whole application (and upstream services) or slowing down other parts Limit the number of concurrent calls, queue excess calls, and fail calls that exceed capacity ✅
🏃‍♂️ Rate Limiter A microservice can be called at any rate, including one that could bring it down if triggered accidentally Limit the rate at which your system can be accessed ✅
🤝 Fallback Nothing guarantees that your dependencies will work. What do you do when they fail? Degrade gracefully by providing default values or placeholders when dependencies are down ✅

Inspired by Polly's Resiliency Policies

Stay Tuned

Hyx is a young but rapidly evolving project. There are tons of things we want to support and integrate with to make Hyx suitable for different frameworks and use cases.

If you don't want to miss our updates, consider the following options:

Thanks

Quote

We are staying on the shoulders of giants (c)

There are some open source projects and other resources that heavily influenced and inspired Hyx to emerge. Without those projects and people behind them, Hyx wouldn't have been created. So I wanted to pause for a moment to say a huge thanks wholeheartedly ❤ to:

License

This project is licensed under the terms of the Apache 2.0 license.