From ce6267f6f8bb9de331b3a55e0e5f183fa4427f92 Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Sun, 21 Jan 2018 23:51:20 +0200 Subject: [PATCH] Add use cases miniapp to docs --- docs/examples/index.rst | 1 + docs/examples/use_cases_miniapp.rst | 57 ++++++++++++++++++++++++++ examples/miniapps/use_cases/README.rst | 4 +- 3 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 docs/examples/use_cases_miniapp.rst diff --git a/docs/examples/index.rst b/docs/examples/index.rst index 230bf2ef..7c375cd8 100644 --- a/docs/examples/index.rst +++ b/docs/examples/index.rst @@ -18,3 +18,4 @@ and powered by *Dependency Injector* framework. movie_lister services_miniapp bundles_miniapp + use_cases_miniapp diff --git a/docs/examples/use_cases_miniapp.rst b/docs/examples/use_cases_miniapp.rst new file mode 100644 index 00000000..cf4a8ab4 --- /dev/null +++ b/docs/examples/use_cases_miniapp.rst @@ -0,0 +1,57 @@ +Use cases mini application example +---------------------------------- + +.. currentmodule:: dependency_injector.providers + +"Use cases" miniapp demonstrate usage of :py:class:`DependenciesContainer` +provider. + +Example application +~~~~~~~~~~~~~~~~~~~ + +"Use cases" mini application has next structure: + +.. code-block:: bash + + use_cases/ + example/ <-- Example package + __init__.py + adapters.py + use_cases.py + containers.py <-- Dependency injection containers + run.py <-- Entrypoint + + +IoC containers +~~~~~~~~~~~~~~ + +Listing of ``use_cases/containers.py``: + +.. literalinclude:: ../../examples/miniapps/use_cases/containers.py + :language: python + :linenos: + +Run application +~~~~~~~~~~~~~~~ + +Listing of ``run.py``: + +.. literalinclude:: ../../examples/miniapps/use_cases/run.py + :language: python + :linenos: + +Instructions for running: + +.. code-block:: bash + + python run.py prod example@example.com # Running in "production" environment + python run.py test example@example.com # Running in "testing" environment + +Links +~~~~~ + ++ `Dependency Injector `_ ++ `Full example sources `_ + + +.. disqus:: diff --git a/examples/miniapps/use_cases/README.rst b/examples/miniapps/use_cases/README.rst index ed860891..44db341b 100644 --- a/examples/miniapps/use_cases/README.rst +++ b/examples/miniapps/use_cases/README.rst @@ -5,5 +5,5 @@ Instructions for running .. code-block:: bash - python run.py prod example@example.com - python run.py test example@example.com + python run.py prod example@example.com # Running in "production" environment + python run.py test example@example.com # Running in "testing" environment