mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 17:47:02 +03:00
Update all links to docs to use https (#305)
* Update README * Update docs * Update examples * Update changelog
This commit is contained in:
parent
ca9a2a5692
commit
452a13c9f7
42
README.rst
42
README.rst
|
@ -39,8 +39,8 @@
|
||||||
:target: https://travis-ci.org/ets-labs/python-dependency-injector
|
:target: https://travis-ci.org/ets-labs/python-dependency-injector
|
||||||
:alt: Build Status
|
:alt: Build Status
|
||||||
|
|
||||||
.. image:: http://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
|
.. image:: https://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
|
||||||
:target: http://python-dependency-injector.ets-labs.org/
|
:target: https://python-dependency-injector.ets-labs.org/
|
||||||
:alt: Docs Status
|
:alt: Docs Status
|
||||||
|
|
||||||
.. image:: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master
|
.. image:: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master
|
||||||
|
@ -58,20 +58,20 @@ Key features of the ``Dependency Injector``:
|
||||||
|
|
||||||
- **Providers**. Provides ``Factory``, ``Singleton``, ``Callable``, ``Coroutine``, ``Object``,
|
- **Providers**. Provides ``Factory``, ``Singleton``, ``Callable``, ``Coroutine``, ``Object``,
|
||||||
``List``, ``Configuration``, ``Dependency`` and ``Selector`` providers that help assembling your
|
``List``, ``Configuration``, ``Dependency`` and ``Selector`` providers that help assembling your
|
||||||
objects. See `Providers <http://python-dependency-injector.ets-labs.org/providers/index.html>`_.
|
objects. See `Providers <https://python-dependency-injector.ets-labs.org/providers/index.html>`_.
|
||||||
- **Overriding**. Can override any provider by another provider on the fly. This helps in testing
|
- **Overriding**. Can override any provider by another provider on the fly. This helps in testing
|
||||||
and configuring dev / stage environment to replace API clients with stubs etc. See
|
and configuring dev / stage environment to replace API clients with stubs etc. See
|
||||||
`Provider overriding <http://python-dependency-injector.ets-labs.org/providers/overriding.html>`_.
|
`Provider overriding <https://python-dependency-injector.ets-labs.org/providers/overriding.html>`_.
|
||||||
- **Configuration**. Read configuration from ``yaml`` & ``ini`` files, environment variables
|
- **Configuration**. Read configuration from ``yaml`` & ``ini`` files, environment variables
|
||||||
and dictionaries.
|
and dictionaries.
|
||||||
See `Configuration provider <http://python-dependency-injector.ets-labs.org/providers/configuration.html>`_.
|
See `Configuration provider <https://python-dependency-injector.ets-labs.org/providers/configuration.html>`_.
|
||||||
- **Containers**. Provides declarative and dynamic containers.
|
- **Containers**. Provides declarative and dynamic containers.
|
||||||
See `Containers <http://python-dependency-injector.ets-labs.org/containers/index.html>`_.
|
See `Containers <https://python-dependency-injector.ets-labs.org/containers/index.html>`_.
|
||||||
- **Wiring**. Injects dependencies into functions and methods. Helps integrating with
|
- **Wiring**. Injects dependencies into functions and methods. Helps integrating with
|
||||||
other frameworks: Django, Flask, Aiohttp, etc.
|
other frameworks: Django, Flask, Aiohttp, etc.
|
||||||
See `Wiring <http://python-dependency-injector.ets-labs.org/wiring.html>`_.
|
See `Wiring <https://python-dependency-injector.ets-labs.org/wiring.html>`_.
|
||||||
- **Typing**. Provides typing stubs, ``mypy``-friendly.
|
- **Typing**. Provides typing stubs, ``mypy``-friendly.
|
||||||
See `Typing and mypy <http://python-dependency-injector.ets-labs.org/providers/typing_mypy.html>`_.
|
See `Typing and mypy <https://python-dependency-injector.ets-labs.org/providers/typing_mypy.html>`_.
|
||||||
- **Performance**. Fast. Written in ``Cython``.
|
- **Performance**. Fast. Written in ``Cython``.
|
||||||
- **Maturity**. Mature and production-ready. Well-tested, documented and supported.
|
- **Maturity**. Mature and production-ready. Well-tested, documented and supported.
|
||||||
|
|
||||||
|
@ -130,7 +130,7 @@ This makes easier to understand and change how application works.
|
||||||
:target: https://github.com/ets-labs/python-dependency-injector
|
:target: https://github.com/ets-labs/python-dependency-injector
|
||||||
|
|
||||||
Visit the docs to know more about the
|
Visit the docs to know more about the
|
||||||
`Dependency injection and inversion of control in Python <http://python-dependency-injector.ets-labs.org/introduction/di_in_python.html>`_.
|
`Dependency injection and inversion of control in Python <https://python-dependency-injector.ets-labs.org/introduction/di_in_python.html>`_.
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
@ -142,30 +142,30 @@ The package is available on the `PyPi`_::
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The documentation is available on the `Read The Docs <http://python-dependency-injector.ets-labs.org/>`_
|
The documentation is available on the `Read The Docs <https://python-dependency-injector.ets-labs.org/>`_
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Choose one of the following:
|
Choose one of the following:
|
||||||
|
|
||||||
- `Application example (single container) <http://python-dependency-injector.ets-labs.org/examples/application-single-container.html>`_
|
- `Application example (single container) <https://python-dependency-injector.ets-labs.org/examples/application-single-container.html>`_
|
||||||
- `Application example (multiple containers) <http://python-dependency-injector.ets-labs.org/examples/application-multiple-containers.html>`_
|
- `Application example (multiple containers) <https://python-dependency-injector.ets-labs.org/examples/application-multiple-containers.html>`_
|
||||||
- `Decoupled packages example (multiple containers) <http://python-dependency-injector.ets-labs.org/examples/decoupled-packages.html>`_
|
- `Decoupled packages example (multiple containers) <https://python-dependency-injector.ets-labs.org/examples/decoupled-packages.html>`_
|
||||||
- `Django example <http://python-dependency-injector.ets-labs.org/examples/django.html>`_
|
- `Django example <https://python-dependency-injector.ets-labs.org/examples/django.html>`_
|
||||||
- `Flask example <http://python-dependency-injector.ets-labs.org/examples/flask.html>`_
|
- `Flask example <https://python-dependency-injector.ets-labs.org/examples/flask.html>`_
|
||||||
- `Aiohttp example <http://python-dependency-injector.ets-labs.org/examples/aiohttp.html>`_
|
- `Aiohttp example <https://python-dependency-injector.ets-labs.org/examples/aiohttp.html>`_
|
||||||
- `Sanic example <http://python-dependency-injector.ets-labs.org/examples/sanic.html>`_
|
- `Sanic example <https://python-dependency-injector.ets-labs.org/examples/sanic.html>`_
|
||||||
|
|
||||||
Tutorials
|
Tutorials
|
||||||
---------
|
---------
|
||||||
|
|
||||||
Choose one of the following:
|
Choose one of the following:
|
||||||
|
|
||||||
- `Flask web application tutorial <http://python-dependency-injector.ets-labs.org/tutorials/flask.html>`_
|
- `Flask web application tutorial <https://python-dependency-injector.ets-labs.org/tutorials/flask.html>`_
|
||||||
- `Aiohttp REST API tutorial <http://python-dependency-injector.ets-labs.org/tutorials/aiohttp.html>`_
|
- `Aiohttp REST API tutorial <https://python-dependency-injector.ets-labs.org/tutorials/aiohttp.html>`_
|
||||||
- `Asyncio monitoring daemon tutorial <http://python-dependency-injector.ets-labs.org/tutorials/asyncio-daemon.html>`_
|
- `Asyncio monitoring daemon tutorial <https://python-dependency-injector.ets-labs.org/tutorials/asyncio-daemon.html>`_
|
||||||
- `CLI application tutorial <http://python-dependency-injector.ets-labs.org/tutorials/cli.html>`_
|
- `CLI application tutorial <https://python-dependency-injector.ets-labs.org/tutorials/cli.html>`_
|
||||||
|
|
||||||
Concept
|
Concept
|
||||||
-------
|
-------
|
||||||
|
|
|
@ -54,8 +54,8 @@ Dependency Injector --- Dependency injection framework for Python
|
||||||
:target: https://travis-ci.org/ets-labs/python-dependency-injector
|
:target: https://travis-ci.org/ets-labs/python-dependency-injector
|
||||||
:alt: Build Status
|
:alt: Build Status
|
||||||
|
|
||||||
.. image:: http://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
|
.. image:: https://readthedocs.org/projects/python-dependency-injector/badge/?version=latest
|
||||||
:target: http://python-dependency-injector.ets-labs.org/
|
:target: https://python-dependency-injector.ets-labs.org/
|
||||||
:alt: Docs Status
|
:alt: Docs Status
|
||||||
|
|
||||||
.. image:: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master
|
.. image:: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master
|
||||||
|
|
|
@ -7,6 +7,10 @@ that were made in every particular version.
|
||||||
From version 0.7.6 *Dependency Injector* framework strictly
|
From version 0.7.6 *Dependency Injector* framework strictly
|
||||||
follows `Semantic versioning`_
|
follows `Semantic versioning`_
|
||||||
|
|
||||||
|
Develop
|
||||||
|
-------
|
||||||
|
- Update all links in documentation and examples to use ``https://`` instead of ``http``.
|
||||||
|
|
||||||
4.0.4
|
4.0.4
|
||||||
-----
|
-----
|
||||||
- Fix typing stubs for ``container.override()`` method.
|
- Fix typing stubs for ``container.override()`` method.
|
||||||
|
@ -1191,4 +1195,4 @@ Previous versions
|
||||||
.. disqus::
|
.. disqus::
|
||||||
|
|
||||||
|
|
||||||
.. _Semantic versioning: http://semver.org/
|
.. _Semantic versioning: https://semver.org/
|
||||||
|
|
|
@ -304,7 +304,7 @@ and put next into it:
|
||||||
|
|
||||||
class GiphyClient:
|
class GiphyClient:
|
||||||
|
|
||||||
API_URL = 'http://api.giphy.com/v1'
|
API_URL = 'https://api.giphy.com/v1'
|
||||||
|
|
||||||
def __init__(self, api_key, timeout):
|
def __init__(self, api_key, timeout):
|
||||||
self._api_key = api_key
|
self._api_key = api_key
|
||||||
|
|
|
@ -738,14 +738,14 @@ You should see:
|
||||||
|
|
||||||
Our daemon can monitor `http://example.com <http://example.com>`_ availability.
|
Our daemon can monitor `http://example.com <http://example.com>`_ availability.
|
||||||
|
|
||||||
Let's add a monitor for the `http://httpbin.org <http://httpbin.org>`_.
|
Let's add a monitor for the `https://httpbin.org <https://httpbin.org>`_.
|
||||||
|
|
||||||
Httpbin.org monitor
|
Httpbin.org monitor
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
Adding of a monitor for the `httpbin.org`_ will be much easier because we have all the
|
Adding of a monitor for the `https://httpbin.org <https://httpbin.org>`_ will be much
|
||||||
components ready. We just need to create a new provider in the container and update the
|
easier because we have all the components ready. We just need to create a new provider
|
||||||
configuration.
|
in the container and update the configuration.
|
||||||
|
|
||||||
Edit ``containers.py``:
|
Edit ``containers.py``:
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,7 @@ How does Movie Lister work?
|
||||||
Movie Lister is a naive example from Martin Fowler's article about the dependency injection and
|
Movie Lister is a naive example from Martin Fowler's article about the dependency injection and
|
||||||
inversion of control:
|
inversion of control:
|
||||||
|
|
||||||
http://www.martinfowler.com/articles/injection.html
|
https://www.martinfowler.com/articles/injection.html
|
||||||
|
|
||||||
Here is a class diagram of the Movie Lister application:
|
Here is a class diagram of the Movie Lister application:
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ Aiohttp + Dependency Injector Example
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
This is an `Aiohttp <https://docs.aiohttp.org/>`_ +
|
This is an `Aiohttp <https://docs.aiohttp.org/>`_ +
|
||||||
`Dependency Injector <http://python-dependency-injector.ets-labs.org/>`_ example application.
|
`Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.
|
||||||
|
|
||||||
The example application is a REST API that searches for funny GIFs on the `Giphy <https://giphy.com/>`_.
|
The example application is a REST API that searches for funny GIFs on the `Giphy <https://giphy.com/>`_.
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ from aiohttp import ClientSession, ClientTimeout
|
||||||
|
|
||||||
class GiphyClient:
|
class GiphyClient:
|
||||||
|
|
||||||
API_URL = 'http://api.giphy.com/v1'
|
API_URL = 'https://api.giphy.com/v1'
|
||||||
|
|
||||||
def __init__(self, api_key, timeout):
|
def __init__(self, api_key, timeout):
|
||||||
self._api_key = api_key
|
self._api_key = api_key
|
||||||
|
|
|
@ -2,7 +2,7 @@ Asyncio Daemon + Dependency Injector Example
|
||||||
============================================
|
============================================
|
||||||
|
|
||||||
This is an `asyncio <https://docs.python.org/3/library/asyncio.html>`_ +
|
This is an `asyncio <https://docs.python.org/3/library/asyncio.html>`_ +
|
||||||
`Dependency Injector <http://python-dependency-injector.ets-labs.org/>`_ example application.
|
`Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.
|
||||||
|
|
||||||
The example application is a daemon that monitors availability of web services.
|
The example application is a daemon that monitors availability of web services.
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ Django + Dependency Injector Example
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
This is a `Django <https://www.djangoproject.com/>`_ +
|
This is a `Django <https://www.djangoproject.com/>`_ +
|
||||||
`Dependency Injector <http://python-dependency-injector.ets-labs.org/>`_ example application.
|
`Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.
|
||||||
|
|
||||||
The example application helps to search for repositories on the Github.
|
The example application helps to search for repositories on the Github.
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ Flask + Dependency Injector Example
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
This is a `Flask <https://flask.palletsprojects.com/>`_ +
|
This is a `Flask <https://flask.palletsprojects.com/>`_ +
|
||||||
`Dependency Injector <http://python-dependency-injector.ets-labs.org/>`_ example application.
|
`Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.
|
||||||
|
|
||||||
The example application helps to search for repositories on the Github.
|
The example application helps to search for repositories on the Github.
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ Movie lister - a naive example of dependency injection in Python
|
||||||
This is a Python implementation of the dependency injection example from Martin Fowler's
|
This is a Python implementation of the dependency injection example from Martin Fowler's
|
||||||
article:
|
article:
|
||||||
|
|
||||||
http://www.martinfowler.com/articles/injection.html
|
https://www.martinfowler.com/articles/injection.html
|
||||||
|
|
||||||
Run
|
Run
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@ Sanic + Dependency Injector Example
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
This is a `Sanic <https://sanic.readthedocs.io/en/latest/index.html>`_ +
|
This is a `Sanic <https://sanic.readthedocs.io/en/latest/index.html>`_ +
|
||||||
`Dependency Injector <http://python-dependency-injector.ets-labs.org/>`_ example application.
|
`Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.
|
||||||
|
|
||||||
The example application is a REST API that searches for funny GIFs on the `Giphy <https://giphy.com/>`_.
|
The example application is a REST API that searches for funny GIFs on the `Giphy <https://giphy.com/>`_.
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ from aiohttp import ClientSession, ClientTimeout
|
||||||
|
|
||||||
class GiphyClient:
|
class GiphyClient:
|
||||||
|
|
||||||
API_URL = 'http://api.giphy.com/v1'
|
API_URL = 'https://api.giphy.com/v1'
|
||||||
|
|
||||||
def __init__(self, api_key, timeout):
|
def __init__(self, api_key, timeout):
|
||||||
self._api_key = api_key
|
self._api_key = api_key
|
||||||
|
|
Loading…
Reference in New Issue
Block a user