Dependency injection framework for Python
Go to file
Roman Mogylatov fa469618dd
Readme update (#263)
* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Add files via upload

* Update README.rst

* Rename Blank Diagram (1).svg to di-map.svg

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Add files via upload

* Rename Blank Diagram (2).svg to di-map2.svg

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Add files via upload

* Add files via upload

* Rename README.svg to di-map3.svg

* Update README.rst

* Add files via upload

* Rename README - Page 3.svg to di-map4.svg

* Update README.rst

* Add files via upload

* Rename README - Copy of Page 3.svg to di-map5.svg

* Update README.rst

* Delete di-map.svg

* Delete di-map2.svg

* Delete di-map3.svg

* Delete di-map4.svg

* Update README.rst

* Update README.rst

* Add Github Navigator - Flask application

* Do more refactoring for ghnav-flask

* More refactoring

* Update README

* Add tests

* Update readme

* Add Flask extension

* Add Factory.provides attribute

* Add Flask extension module

* User flask extension in githubnavigator example

* Add README for ghnav-flask

* Update ghnav-flask README

* Update ghnav-flask README

* Update README with ghnav container example

* Move ghnav-flask to miniapps/ folder

* Fix auth token reading from env for ghnav-flask

* Update readme

* Fix ghnav-flask linter errors

* Add downloads and wheel badge

* Add tests for flask extension

* Fix flask tests

* Add requirements-ext.txt installation to tox.ini

* Add API docs for ext.flask module

* Update setup.py

* Add Flask to the list of keywords

* Update badges on docs README

* Update docs README title

* Fix ext.flask tests

* Fix syntax of ext.flask for Python 2.7, 3.4, 3.5

* Fix syntax of ext.flask for Python 2.7, 3.4, 3.5

* Fix imports in ext.flask for Python 2.7, 3.4, 3.5

* Update ghfnav-flask README

* Update ghfnav-flask README

* Remove setting of empty github token

* Add flask extras

* Update requirements

* Update requirements

* Add flask extra to python 3.4 tox.ini

* Update changelog

* Update changelog
2020-07-11 12:15:00 -04:00
docs Readme update (#263) 2020-07-11 12:15:00 -04:00
examples Readme update (#263) 2020-07-11 12:15:00 -04:00
src/dependency_injector Readme update (#263) 2020-07-11 12:15:00 -04:00
tests Readme update (#263) 2020-07-11 12:15:00 -04:00
.coveragerc Clean up and final fixes 2016-11-02 23:55:14 +02:00
.gitignore Remove providers/utils.h 2016-11-15 14:19:17 +02:00
.pylintrc Update repository structure 2016-11-02 22:58:30 +02:00
.travis.yml Update travis config to publish to real pypi 2020-07-01 23:18:41 -04:00
CONTRIBUTORS.rst Add RobinsonMa to the list of contributors 2020-06-16 22:25:41 -04:00
LICENSE.rst Update copyright date 2017-01-11 00:08:21 +02:00
Makefile Update makefile 2020-07-01 23:20:28 -04:00
MANIFEST.in Adds tests in MANIFEST.in (#204) 2018-09-02 20:54:06 +03:00
README.rst Readme update (#263) 2020-07-11 12:15:00 -04:00
requirements-dev.txt Readme update (#263) 2020-07-11 12:15:00 -04:00
requirements-doc.txt Readme update (#263) 2020-07-11 12:15:00 -04:00
requirements-ext.txt Readme update (#263) 2020-07-11 12:15:00 -04:00
requirements.txt Add support of six 1.15.0 2020-06-14 17:43:06 -04:00
setup.cfg Add flake8 config 2020-06-25 18:01:15 -04:00
setup.py Readme update (#263) 2020-07-11 12:15:00 -04:00
tox.ini Readme update (#263) 2020-07-11 12:15:00 -04:00

.. figure:: https://raw.githubusercontent.com/wiki/ets-labs/python-dependency-injector/img/logo.svg
   :target: https://github.com/ets-labs/python-dependency-injector

| 

.. image:: https://img.shields.io/pypi/v/dependency_injector.svg
   :target: https://pypi.org/project/dependency-injector/
   :alt: Latest Version
   
.. image:: https://img.shields.io/pypi/l/dependency_injector.svg
   :target: https://pypi.org/project/dependency-injector/
   :alt: License

.. image:: https://img.shields.io/pypi/pyversions/dependency_injector.svg
   :target: https://pypi.org/project/dependency-injector/
   :alt: Supported Python versions
   
.. image:: https://img.shields.io/pypi/implementation/dependency_injector.svg
   :target: https://pypi.org/project/dependency-injector/
   :alt: Supported Python implementations

.. 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

.. 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
   
.. image:: http://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
   :target: http://python-dependency-injector.ets-labs.org/
   :alt: Docs Status
   
.. 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``?
================================

``Dependency Injector`` is a dependency injection framework for Python.

Why do I need it?
=================

``Dependency Injector`` helps you improve application structure.

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.

.. figure:: https://raw.githubusercontent.com/wiki/ets-labs/python-dependency-injector/img/di-map.svg
   :target: https://github.com/ets-labs/python-dependency-injector

*The container is like a map of your application. You always know what depends on what.*

``Flask`` + ``Dependency Injector`` example:

.. code-block:: python

    from dependency_injector import containers, providers
    from dependency_injector.ext import flask
    from github import Github

    from . import services, views


    class Application(containers.DeclarativeContainer):
        """Application container."""

        config = providers.Configuration()

        github_client = providers.Factory(
            Github,
            login_or_token=config.github.auth_token,
            timeout=config.github.request_timeout,
        )

        search_service = providers.Factory(
            services.SearchService,
            github_client=github_client,
        )

        index_view = providers.Callable(
            views.index,
            search_service=search_service,
            default_search_term=config.search.default_term,
            default_search_limit=config.search.default_limit,
        )

        app = providers.Factory(
            flask.create_app,
            name=__name__,
            routes=[
                flask.Route('/', view_provider=index_view),
            ],
        )


See complete example here - `Flask + Dependency Injector Example <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/ghnav-flask>`_

How to install?
---------------

- The package is available on the `PyPi`_::

    pip install dependency-injector

Where is the docs?
------------------

- The documentation is available on the `Read The Docs <http://python-dependency-injector.ets-labs.org/>`_

Have a question?
----------------

- 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?
-------------

- ⭐️ Star the ``Dependency Injector`` on the `Github <https://github.com/ets-labs/python-dependency-injector/>`_
- 🆕 Start a new project with the ``Dependency Injector``
- 💬 Tell your friend about the ``Dependency Injector``


Want to contribute?
-------------------

- 🔀 Fork the project
- ⬅️ Open a pull request to the ``develop`` branch

.. _PyPi: https://pypi.org/project/dependency-injector/