2020-07-03 05:07:07 +03:00
.. figure :: https://raw.githubusercontent.com/wiki/ets-labs/python-dependency-injector/img/logo.svg
2020-07-11 19:15:00 +03:00
:target: https://github.com/ets-labs/python-dependency-injector
2020-07-03 05:07:07 +03:00
|
.. image :: https://img.shields.io/pypi/v/dependency_injector.svg
:target: https://pypi.org/project/dependency-injector/
:alt: Latest Version
2020-07-11 19:15:00 +03:00
2020-07-03 05:07:07 +03:00
.. image :: https://img.shields.io/pypi/l/dependency_injector.svg
:target: https://pypi.org/project/dependency-injector/
:alt: License
2020-07-11 19:15:00 +03:00
2020-07-03 05:07:07 +03:00
.. image :: https://img.shields.io/pypi/pyversions/dependency_injector.svg
:target: https://pypi.org/project/dependency-injector/
:alt: Supported Python versions
2020-07-11 19:15:00 +03:00
2020-07-03 05:07:07 +03:00
.. image :: https://img.shields.io/pypi/implementation/dependency_injector.svg
:target: https://pypi.org/project/dependency-injector/
:alt: Supported Python implementations
2020-07-11 19:15:00 +03:00
.. image :: https://pepy.tech/badge/dependency-injector
:target: https://pepy.tech/project/dependency-injector
:alt: Downloads
.. image :: https://pepy.tech/badge/dependency-injector/month
:target: https://pepy.tech/project/dependency-injector
:alt: Downloads
.. image :: https://pepy.tech/badge/dependency-injector/week
:target: https://pepy.tech/project/dependency-injector
:alt: Downloads
.. image :: https://img.shields.io/pypi/wheel/dependency-injector.svg
:target: https://pypi.org/project/dependency-injector/
:alt: Wheel
2020-07-03 05:07:07 +03:00
.. image :: https://travis-ci.org/ets-labs/python-dependency-injector.svg?branch=master
:target: https://travis-ci.org/ets-labs/python-dependency-injector
:alt: Build Status
2020-07-11 19:15:00 +03:00
2020-07-03 05:07:07 +03:00
.. image :: http://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
:target: http://python-dependency-injector.ets-labs.org/
:alt: Docs Status
2020-07-11 19:15:00 +03:00
2020-07-03 05:07:07 +03:00
.. image :: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master
:target: https://coveralls.io/github/ets-labs/python-dependency-injector?branch=master
:alt: Coverage Status
What is `` Dependency Injector `` ?
================================
2020-07-11 19:15:00 +03:00
`` Dependency Injector `` is a dependency injection framework for Python.
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
Why do I need it?
=================
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
`` Dependency Injector `` helps you improve application structure.
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
With the `` Dependency Injector `` you keep **application structure in one place** .
This place is called **the container** . You use the container to manage all the components of the application. All the component dependencies are defined explicitly. This provides the control on the application structure. It is **easy to understand and change** it.
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
.. figure :: https://raw.githubusercontent.com/wiki/ets-labs/python-dependency-injector/img/di-map.svg
:target: https://github.com/ets-labs/python-dependency-injector
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
*The container is like a map of your application. You always know what depends on what.*
2016-12-28 00:06:40 +03:00
2020-07-11 19:15:00 +03:00
`` Flask `` + `` Dependency Injector `` example:
2016-12-28 00:06:40 +03:00
.. code-block :: python
2018-07-02 16:43:23 +03:00
from dependency_injector import containers, providers
2020-07-11 19:15:00 +03:00
from dependency_injector.ext import flask
from github import Github
2016-04-20 14:25:40 +03:00
2020-07-11 19:15:00 +03:00
from . import services, views
2016-03-09 11:49:49 +03:00
2020-07-11 19:15:00 +03:00
class Application(containers.DeclarativeContainer):
"""Application container."""
2016-10-06 22:48:43 +03:00
2020-07-11 19:15:00 +03:00
config = providers.Configuration()
2016-12-02 21:59:12 +03:00
2020-07-11 19:15:00 +03:00
github_client = providers.Factory(
Github,
login_or_token=config.github.auth_token,
timeout=config.github.request_timeout,
2018-07-02 16:43:23 +03:00
)
2016-03-09 11:49:49 +03:00
2020-07-11 19:15:00 +03:00
search_service = providers.Factory(
services.SearchService,
github_client=github_client,
2018-07-02 16:43:23 +03:00
)
2016-03-09 11:49:49 +03:00
2020-07-11 19:15:00 +03:00
index_view = providers.Callable(
views.index,
search_service=search_service,
default_search_term=config.search.default_term,
default_search_limit=config.search.default_limit,
2018-07-02 16:43:23 +03:00
)
2016-06-01 19:52:10 +03:00
2020-07-11 19:15:00 +03:00
app = providers.Factory(
flask.create_app,
name=__name__,
routes=[
flask.Route('/', view_provider=index_view),
],
2018-07-02 16:43:23 +03:00
)
2016-05-18 23:18:29 +03:00
2020-07-11 19:15:00 +03:00
See complete example here - `Flask + Dependency Injector Example <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/ghnav-flask> `_
2016-05-18 23:18:29 +03:00
2020-07-11 19:15:00 +03:00
How to install?
---------------
2016-03-09 11:49:49 +03:00
2020-07-11 19:15:00 +03:00
- The package is available on the `PyPi`_ ::
2016-01-11 12:14:37 +03:00
2020-07-11 19:15:00 +03:00
pip install dependency-injector
2016-10-06 22:48:43 +03:00
2020-07-11 19:15:00 +03:00
Where is the docs?
------------------
2016-09-18 23:00:10 +03:00
2020-07-11 19:15:00 +03:00
- The documentation is available on the `Read The Docs <http://python-dependency-injector.ets-labs.org/> `_
2015-04-03 00:40:03 +03:00
2020-07-11 19:15:00 +03:00
Have a question?
----------------
2015-04-03 00:35:22 +03:00
2020-07-11 19:15:00 +03:00
- Open a `Github Issue <https://github.com/ets-labs/python-dependency-injector/issues> `_
Found a bug?
------------
- Open a `Github Issue <https://github.com/ets-labs/python-dependency-injector/issues> `_
Want to help?
-------------
2015-04-03 00:33:28 +03:00
2020-07-11 20:15:27 +03:00
- |star| Star the `` Dependency Injector `` on the `Github <https://github.com/ets-labs/python-dependency-injector/> `_
2020-07-11 20:02:30 +03:00
- |new| Start a new project with the `` Dependency Injector ``
- |tell| Tell your friend about the `` Dependency Injector ``
2015-04-03 00:33:28 +03:00
2020-07-11 19:15:00 +03:00
Want to contribute?
-------------------
2015-04-03 00:33:28 +03:00
2020-07-11 20:02:30 +03:00
- |fork| Fork the project
2020-07-11 20:15:27 +03:00
- |pull| Open a pull request to the `` develop `` branch
2015-04-03 00:29:00 +03:00
2020-01-27 04:37:13 +03:00
.. _PyPi: https://pypi.org/project/dependency-injector/
2020-07-11 20:02:30 +03:00
2020-07-11 20:15:27 +03:00
.. |star| unicode :: U+2B50 U+FE0F .. star sign1
2020-07-11 20:10:46 +03:00
.. |new| unicode :: U+1F195 .. new sign
.. |tell| unicode :: U+1F4AC .. tell sign
.. |fork| unicode :: U+1F500 .. fork sign
2020-07-11 20:15:27 +03:00
.. |pull| unicode :: U+2B05 U+FE0F .. pull sign