mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2025-10-31 16:07:51 +03:00
d45d98e300
* Add application * Dockerize the app * Fix 204 content-leength error * Rename database file * Add tests * Add README * Fix a typo in FastAPI example * Add docs on FastAPI + SQLAlchemy example * Update changelog * Add link to the example to README and other docs pages * Add EOF to the config.yml
122 lines
3.6 KiB
ReStructuredText
122 lines
3.6 KiB
ReStructuredText
FastAPI + Dependency Injector Example
|
|
=====================================
|
|
|
|
This is a `FastAPI <https://fastapi.tiangolo.com/>`_ +
|
|
`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/>`_.
|
|
|
|
Run
|
|
---
|
|
|
|
Create virtual environment:
|
|
|
|
.. code-block:: bash
|
|
|
|
virtualenv venv
|
|
. venv/bin/activate
|
|
|
|
Install requirements:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -r requirements.txt
|
|
|
|
To run the application do:
|
|
|
|
.. code-block:: bash
|
|
|
|
export GIPHY_API_KEY=wBJ2wZG7SRqfrU9nPgPiWvORmloDyuL0
|
|
uvicorn giphynavigator.application:app --reload
|
|
|
|
The output should be something like:
|
|
|
|
.. code-block::
|
|
|
|
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
|
INFO: Started reloader process [4795] using watchgod
|
|
INFO: Started server process [4797]
|
|
INFO: Waiting for application startup.
|
|
INFO: Application startup complete.
|
|
|
|
After that visit http://127.0.0.1:8000/ in your browser or use CLI command (``curl``, ``httpie``,
|
|
etc). You should see something like:
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"query": "Dependency Injector",
|
|
"limit": 10,
|
|
"gifs": [
|
|
{
|
|
"url": "https://giphy.com/gifs/boxes-dependent-swbf2-6Eo7KzABxgJMY"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/depends-J56qCcOhk6hKE"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/web-series-ccstudios-bro-dependent-1lhU8KAVwmVVu"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/TheBoysTV-friends-friend-weneedeachother-XxR9qcIwcf5Jq404Sx"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/netflix-a-series-of-unfortunate-events-asoue-9rgeQXbwoK53pcxn7f"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/black-and-white-sad-skins-Hs4YzLs2zJuLu"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/always-there-for-you-i-am-here-PlayjhCco9jHBYrd9w"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/stream-famous-dollar-YT2dvOByEwXCdoYiA1"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/i-love-you-there-for-am-1BhGzgpZXYWwWMAGB1"
|
|
},
|
|
{
|
|
"url": "https://giphy.com/gifs/life-like-twerk-9hlnWxjHqmH28"
|
|
}
|
|
]
|
|
}
|
|
|
|
.. note::
|
|
|
|
To create your own Giphy API key follow this
|
|
`guide <https://support.giphy.com/hc/en-us/articles/360020283431-Request-A-GIPHY-API-Key>`_.
|
|
|
|
Test
|
|
----
|
|
|
|
This application comes with the unit tests.
|
|
|
|
To run the tests do:
|
|
|
|
.. code-block:: bash
|
|
|
|
py.test giphynavigator/tests.py --cov=giphynavigator
|
|
|
|
The output should be something like:
|
|
|
|
.. code-block::
|
|
|
|
platform darwin -- Python 3.8.3, pytest-5.4.3, py-1.9.0, pluggy-0.13.1
|
|
plugins: cov-2.10.0, asyncio-0.14.0
|
|
collected 3 items
|
|
|
|
giphynavigator/tests.py ... [100%]
|
|
|
|
---------- coverage: platform darwin, python 3.8.3-final-0 -----------
|
|
Name Stmts Miss Cover
|
|
---------------------------------------------------
|
|
giphynavigator/__init__.py 0 0 100%
|
|
giphynavigator/application.py 13 0 100%
|
|
giphynavigator/containers.py 6 0 100%
|
|
giphynavigator/endpoints.py 20 0 100%
|
|
giphynavigator/giphy.py 14 9 36%
|
|
giphynavigator/services.py 9 1 89%
|
|
giphynavigator/tests.py 38 0 100%
|
|
---------------------------------------------------
|
|
TOTAL 100 10 90%
|