https://github.com/mwiatrzyk/pydio
Simple and functional dependency injection toolkit for Python
https://github.com/mwiatrzyk/pydio
dependency-injection di framework library python toolkit
Last synced: 2 months ago
JSON representation
Simple and functional dependency injection toolkit for Python
- Host: GitHub
- URL: https://github.com/mwiatrzyk/pydio
- Owner: mwiatrzyk
- License: mit
- Created: 2022-10-09T18:33:24.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-10-10T18:55:35.000Z (6 months ago)
- Last Synced: 2025-11-19T03:22:32.686Z (4 months ago)
- Topics: dependency-injection, di, framework, library, python, toolkit
- Language: Python
- Homepage:
- Size: 281 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://codecov.io/gh/mwiatrzyk/pydio)
# PyDio
Simple and functional dependency injection toolkit for Python.
## Name
**PyDio** (pronounced: *"PAI-dee-o"*) stands for **Python Dependency Injection tOolkit**.
## About
PyDio aims to be simple, yet still powerful, allowing you to feed dependencies
inside your application in a flexible way. PyDio design is based on simple
assumption that dependency injection can be achieved using a straightforward
**key-to-function** mapping, where **key** specifies **type of object** you
want to inject and **function** is a **factory** function that creates
**instances** of that type.
In PyDio, this is implemented using **providers** and **injectors**. You use
providers to configure your **key-to-function** mapping, and then you use
injectors to perform a **lookup** of a specific key and creation of the final
object.
Here's a simple example:
```python
import abc
from pydio.api import Provider, Injector
provider = Provider()
@provider.provides('greet')
def make_greet():
return 'Hello, world!'
def main():
injector = Injector(provider)
greet_message = injector.inject('greet')
print(greet_message)
if __name__ == '__main__':
main()
```
Now you can save the snippet from above as ``example.py`` file and execute
to see the output:
```shell
$ python example.py
Hello, world!
```
## Key features
* Support for any hashable keys: class objects, strings, ints etc.
* Support for any type of object factories: function, coroutine, generator,
asynchronous generator.
* Automatic resource management via generator-based factories
(similar to pytest's fixtures)
* Multiple environment support: testing, development, production etc.
* Limiting created object's lifetime to user-defined scopes: global,
application, use-case etc.
* No singletons used, so there is no global state...
* ...but you still can create global injector on your own if you need it :-)
## Installation
You can install PyDio using one of following methods:
1) From PyPI (for stable releases):
```shell
$ pip install PyDio
```
2) From test PyPI (for stable and development releases):
```shell
$ pip install -i https://test.pypi.org/simple/ PyDio
```
3) Directly from source code repository (for all releases):
```shell
$ pip install git+https://gitlab.com/zef1r/PyDio.git@[branch-or-tag]
```
## Documentation
You have two options available:
1) Visit [PyDio's ReadTheDocs](https://pydio.readthedocs.io/en/latest/) site.
2) Take a tour around [functional tests](https://github.com/mwiatrzyk/pydio/tree/master/tests/functional).
## Disclaimer
**PyDio** is an independent open-source project in the Python ecosystem. It
is not affiliated with, sponsored by, or endorsed by any company, organization,
or product of the same or similar name. Any similarity in names is purely
coincidental and does not imply any association.
## License
This project is released under the terms of the MIT license.
See [LICENSE.txt](https://github.com/mwiatrzyk/pydio/blob/master/LICENSE.txt) for more details.
## Author
Maciej Wiatrzyk