Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maldoinc/wireup
Concise, Powerful, and Type-Safe Python Dependency Injection Library
https://github.com/maldoinc/wireup
dependency-injection dependency-injection-container dependency-injector django flask injector python
Last synced: about 2 months ago
JSON representation
Concise, Powerful, and Type-Safe Python Dependency Injection Library
- Host: GitHub
- URL: https://github.com/maldoinc/wireup
- Owner: maldoinc
- License: mit
- Created: 2023-08-19T22:09:32.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-10T22:02:51.000Z (5 months ago)
- Last Synced: 2024-04-11T01:48:30.487Z (5 months ago)
- Topics: dependency-injection, dependency-injection-container, dependency-injector, django, flask, injector, python
- Language: Python
- Homepage: https://maldoinc.github.io/wireup/
- Size: 4.43 MB
- Stars: 55
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
- awesome-dependency-injection-in-python - Wireup - Concise, Powerful, and Type-Safe Python Dependency Injection Library. [🐍, MIT License]. (Software / DI Frameworks / Containers)
README
Wireup
Modern Dependency Injection for Python.
[](https://github.com/maldoinc/wireup)
[](https://github.com/maldoinc/wireup)
[](https://codeclimate.com/github/maldoinc/wireup)
[](https://codeclimate.com/github/maldoinc/wireup)
[](https://pypi.org/project/wireup/)
[](https://pypi.org/project/wireup/)
Wireup is a performant, concise, and easy-to-use dependency injection container for Python 3.8+.
---
## ⚡ Key Features
* Inject services and configuration.
* Support for interfaces and abstract classes.
* Factory pattern.
* Singleton and transient dependencies.
* Framework-agnostic.
* Simplified integration with [Django](https://maldoinc.github.io/wireup/latest/integrations/django/),
[Flask](https://maldoinc.github.io/wireup/latest/integrations/flask/), and
[FastAPI](https://maldoinc.github.io/wireup/latest/integrations/fastapi/).
## 📋 Quickstart
Example showcasing a Redis wrapper and a weather service that calls an external API and caches results as needed.
**1. Set up**
```python
from wireup import container, initialize_container
def create_app():
app = ...
# ⬇️ Expose configuration by populating container.params.
container.params.put("redis_url", os.environ["APP_REDIS_URL"])
container.params.put("weather_api_key", os.environ["APP_WEATHER_API_KEY"])
# Bulk update is possible via the "update" method.
container.params.update(Settings().model_dump())
# Start the container: This registers and initializes services.
# `service_modules` contains top-level modules containing registrations.
# ⬇️
initialize_container(container, service_modules=[services])
return app
```
**2. Register services**
Use a declarative syntax to describe services, and let the container handle the rest.
```python
from wireup import service, Inject
@service # ⬅️ Decorator tells the container this is a service.
class KeyValueStore:
# This tells the container to inject the value
# of the parameter during creation.
# ⬇️
def __init__(self, dsn: Annotated[str, Inject(param="redis_url")]):
self.client = redis.from_url(dsn)
def get(self, key: str) -> Any: ...
def set(self, key: str, value: Any): ...
@service
@dataclass
class WeatherService:
# Inject the value of the parameter to this field. ⬇️
api_key: Annotated[str, Inject(param="weather_api_key")]
kv_store: KeyValueStore # ⬅️ This will be injected automatically without additional metadata.
def get_forecast(self, lat: float, lon: float) -> WeatherForecast:
...
```
**3. Inject**
Decorate targets where the library should perform injection.
```python
from wireup import container
@app.get("/weather/forecast")
# ⬇️ Decorating views with autowire enables the container to inject services/parameters.
@container.autowire
def get_weather_forecast_view(weather_service: WeatherService, request):
return weather_service.get_forecast(request.lat, request.lon)
```
**Installation**
```bash
# Install using poetry:
poetry add wireup
# Install using pip:
pip install wireup
```
## 📑 Documentation
For more information [check out the documentation](https://maldoinc.github.io/wireup)
## 🎮 Demo application
A demo flask application is available at [maldoinc/wireup-demo](https://github.com/maldoinc/wireup-demo)