From 452a13c9f74ffc0f55c40fc0a0164bc7e4b6aa6f Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Mon, 19 Oct 2020 17:18:39 -0400 Subject: [PATCH] Update all links to docs to use https (#305) * Update README * Update docs * Update examples * Update changelog --- README.rst | 42 +++++++++---------- docs/index.rst | 4 +- docs/main/changelog.rst | 6 ++- docs/tutorials/aiohttp.rst | 2 +- docs/tutorials/asyncio-daemon.rst | 8 ++-- docs/tutorials/cli.rst | 2 +- examples/miniapps/aiohttp/README.rst | 2 +- .../miniapps/aiohttp/giphynavigator/giphy.py | 2 +- examples/miniapps/asyncio-daemon/README.rst | 2 +- examples/miniapps/django/README.rst | 2 +- examples/miniapps/flask/README.rst | 2 +- examples/miniapps/movie-lister/README.rst | 2 +- examples/miniapps/sanic/README.rst | 2 +- .../miniapps/sanic/giphynavigator/giphy.py | 2 +- 14 files changed, 42 insertions(+), 38 deletions(-) diff --git a/README.rst b/README.rst index c4b82f9f..a65f96fc 100644 --- a/README.rst +++ b/README.rst @@ -39,8 +39,8 @@ :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/ +.. image:: https://readthedocs.org/projects/python-dependency-injector/badge/?version=latest + :target: https://python-dependency-injector.ets-labs.org/ :alt: Docs Status .. 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``, ``List``, ``Configuration``, ``Dependency`` and ``Selector`` providers that help assembling your - objects. See `Providers `_. + objects. See `Providers `_. - **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 - `Provider overriding `_. + `Provider overriding `_. - **Configuration**. Read configuration from ``yaml`` & ``ini`` files, environment variables and dictionaries. - See `Configuration provider `_. + See `Configuration provider `_. - **Containers**. Provides declarative and dynamic containers. - See `Containers `_. + See `Containers `_. - **Wiring**. Injects dependencies into functions and methods. Helps integrating with other frameworks: Django, Flask, Aiohttp, etc. - See `Wiring `_. + See `Wiring `_. - **Typing**. Provides typing stubs, ``mypy``-friendly. - See `Typing and mypy `_. + See `Typing and mypy `_. - **Performance**. Fast. Written in ``Cython``. - **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 Visit the docs to know more about the -`Dependency injection and inversion of control in Python `_. +`Dependency injection and inversion of control in Python `_. Installation ------------ @@ -142,30 +142,30 @@ The package is available on the `PyPi`_:: Documentation ------------- -The documentation is available on the `Read The Docs `_ +The documentation is available on the `Read The Docs `_ Examples -------- Choose one of the following: -- `Application example (single container) `_ -- `Application example (multiple containers) `_ -- `Decoupled packages example (multiple containers) `_ -- `Django example `_ -- `Flask example `_ -- `Aiohttp example `_ -- `Sanic example `_ +- `Application example (single container) `_ +- `Application example (multiple containers) `_ +- `Decoupled packages example (multiple containers) `_ +- `Django example `_ +- `Flask example `_ +- `Aiohttp example `_ +- `Sanic example `_ Tutorials --------- Choose one of the following: -- `Flask web application tutorial `_ -- `Aiohttp REST API tutorial `_ -- `Asyncio monitoring daemon tutorial `_ -- `CLI application tutorial `_ +- `Flask web application tutorial `_ +- `Aiohttp REST API tutorial `_ +- `Asyncio monitoring daemon tutorial `_ +- `CLI application tutorial `_ Concept ------- diff --git a/docs/index.rst b/docs/index.rst index 06b9ebd5..64b505bb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,8 +54,8 @@ Dependency Injector --- Dependency injection framework for Python :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/ +.. image:: https://readthedocs.org/projects/python-dependency-injector/badge/?version=latest + :target: https://python-dependency-injector.ets-labs.org/ :alt: Docs Status .. image:: https://coveralls.io/repos/github/ets-labs/python-dependency-injector/badge.svg?branch=master diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index 1e392737..ca7b13e6 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -7,6 +7,10 @@ that were made in every particular version. From version 0.7.6 *Dependency Injector* framework strictly follows `Semantic versioning`_ +Develop +------- +- Update all links in documentation and examples to use ``https://`` instead of ``http``. + 4.0.4 ----- - Fix typing stubs for ``container.override()`` method. @@ -1191,4 +1195,4 @@ Previous versions .. disqus:: -.. _Semantic versioning: http://semver.org/ +.. _Semantic versioning: https://semver.org/ diff --git a/docs/tutorials/aiohttp.rst b/docs/tutorials/aiohttp.rst index f6bd083f..9b505c18 100644 --- a/docs/tutorials/aiohttp.rst +++ b/docs/tutorials/aiohttp.rst @@ -304,7 +304,7 @@ and put next into it: class GiphyClient: - API_URL = 'http://api.giphy.com/v1' + API_URL = 'https://api.giphy.com/v1' def __init__(self, api_key, timeout): self._api_key = api_key diff --git a/docs/tutorials/asyncio-daemon.rst b/docs/tutorials/asyncio-daemon.rst index a279771d..bb5413e5 100644 --- a/docs/tutorials/asyncio-daemon.rst +++ b/docs/tutorials/asyncio-daemon.rst @@ -738,14 +738,14 @@ You should see: Our daemon can monitor `http://example.com `_ availability. -Let's add a monitor for the `http://httpbin.org `_. +Let's add a monitor for the `https://httpbin.org `_. Httpbin.org monitor ------------------- -Adding of a monitor for the `httpbin.org`_ will be much easier because we have all the -components ready. We just need to create a new provider in the container and update the -configuration. +Adding of a monitor for the `https://httpbin.org `_ will be much +easier because we have all the components ready. We just need to create a new provider +in the container and update the configuration. Edit ``containers.py``: diff --git a/docs/tutorials/cli.rst b/docs/tutorials/cli.rst index eba7531a..d488cd9c 100644 --- a/docs/tutorials/cli.rst +++ b/docs/tutorials/cli.rst @@ -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 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: diff --git a/examples/miniapps/aiohttp/README.rst b/examples/miniapps/aiohttp/README.rst index bb56fe2b..dd8c00d8 100644 --- a/examples/miniapps/aiohttp/README.rst +++ b/examples/miniapps/aiohttp/README.rst @@ -2,7 +2,7 @@ Aiohttp + Dependency Injector Example ===================================== This is an `Aiohttp `_ + -`Dependency Injector `_ example application. +`Dependency Injector `_ example application. The example application is a REST API that searches for funny GIFs on the `Giphy `_. diff --git a/examples/miniapps/aiohttp/giphynavigator/giphy.py b/examples/miniapps/aiohttp/giphynavigator/giphy.py index 18d0f6b9..22a5f6a4 100644 --- a/examples/miniapps/aiohttp/giphynavigator/giphy.py +++ b/examples/miniapps/aiohttp/giphynavigator/giphy.py @@ -5,7 +5,7 @@ from aiohttp import ClientSession, ClientTimeout class GiphyClient: - API_URL = 'http://api.giphy.com/v1' + API_URL = 'https://api.giphy.com/v1' def __init__(self, api_key, timeout): self._api_key = api_key diff --git a/examples/miniapps/asyncio-daemon/README.rst b/examples/miniapps/asyncio-daemon/README.rst index 0056db48..5bb73022 100644 --- a/examples/miniapps/asyncio-daemon/README.rst +++ b/examples/miniapps/asyncio-daemon/README.rst @@ -2,7 +2,7 @@ Asyncio Daemon + Dependency Injector Example ============================================ This is an `asyncio `_ + -`Dependency Injector `_ example application. +`Dependency Injector `_ example application. The example application is a daemon that monitors availability of web services. diff --git a/examples/miniapps/django/README.rst b/examples/miniapps/django/README.rst index eeac0b97..114f77cb 100644 --- a/examples/miniapps/django/README.rst +++ b/examples/miniapps/django/README.rst @@ -2,7 +2,7 @@ Django + Dependency Injector Example ==================================== This is a `Django `_ + -`Dependency Injector `_ example application. +`Dependency Injector `_ example application. The example application helps to search for repositories on the Github. diff --git a/examples/miniapps/flask/README.rst b/examples/miniapps/flask/README.rst index 7bbd5d99..118c4e52 100644 --- a/examples/miniapps/flask/README.rst +++ b/examples/miniapps/flask/README.rst @@ -2,7 +2,7 @@ Flask + Dependency Injector Example =================================== This is a `Flask `_ + -`Dependency Injector `_ example application. +`Dependency Injector `_ example application. The example application helps to search for repositories on the Github. diff --git a/examples/miniapps/movie-lister/README.rst b/examples/miniapps/movie-lister/README.rst index 15fe2d7e..dcc85066 100644 --- a/examples/miniapps/movie-lister/README.rst +++ b/examples/miniapps/movie-lister/README.rst @@ -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 article: - http://www.martinfowler.com/articles/injection.html + https://www.martinfowler.com/articles/injection.html Run --- diff --git a/examples/miniapps/sanic/README.rst b/examples/miniapps/sanic/README.rst index 4e95e59b..9550fccc 100644 --- a/examples/miniapps/sanic/README.rst +++ b/examples/miniapps/sanic/README.rst @@ -2,7 +2,7 @@ Sanic + Dependency Injector Example =================================== This is a `Sanic `_ + -`Dependency Injector `_ example application. +`Dependency Injector `_ example application. The example application is a REST API that searches for funny GIFs on the `Giphy `_. diff --git a/examples/miniapps/sanic/giphynavigator/giphy.py b/examples/miniapps/sanic/giphynavigator/giphy.py index 18d0f6b9..22a5f6a4 100644 --- a/examples/miniapps/sanic/giphynavigator/giphy.py +++ b/examples/miniapps/sanic/giphynavigator/giphy.py @@ -5,7 +5,7 @@ from aiohttp import ClientSession, ClientTimeout class GiphyClient: - API_URL = 'http://api.giphy.com/v1' + API_URL = 'https://api.giphy.com/v1' def __init__(self, api_key, timeout): self._api_key = api_key