python-dependency-injector/examples/miniapps/fastapi-redis/README.rst

FastAPI + Redis + Dependency Injector Example
=============================================

This is a `FastAPI <https://docs.python.org/3/library/asyncio.html>`_
+ `Redis <https://redis.io/>`_
+ `Dependency Injector <https://python-dependency-injector.ets-labs.org/>`_ example application.

Run
---

Build the Docker image:

.. code-block:: bash

   docker-compose build

Run the docker-compose environment:

.. code-block:: bash

    docker-compose up

The output should be something like:

.. code-block::

   fastapi-redis-redis-1    | 1:C 19 Dec 2022 02:33:02.484 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
   fastapi-redis-redis-1    | 1:C 19 Dec 2022 02:33:02.484 # Redis version=7.0.5, bits=64, commit=00000000, modified=0, pid=1, just started
   fastapi-redis-redis-1    | 1:C 19 Dec 2022 02:33:02.484 # Configuration loaded
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.485 * monotonic clock: POSIX clock_gettime
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.485 * Running mode=standalone, port=6379.
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.485 # Server initialized
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.487 * Loading RDB produced by version 7.0.5
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.487 * RDB age 58 seconds
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.487 * RDB memory usage when created 0.85 Mb
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.487 * Done loading RDB, keys loaded: 0, keys expired: 0.
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.487 * DB loaded from disk: 0.000 seconds
   fastapi-redis-redis-1    | 1:M 19 Dec 2022 02:33:02.488 * Ready to accept connections
   fastapi-redis-example-1  | INFO:     Started server process [1]
   fastapi-redis-example-1  | INFO:     Waiting for application startup.
   fastapi-redis-example-1  | INFO:     Application startup complete.
   fastapi-redis-example-1  | INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
   fastapi-redis-example-1  | INFO:     172.18.0.1:63998 - "GET / HTTP/1.1" 200 OK
   fastapi-redis-example-1  | INFO:     172.18.0.1:63998 - "GET /favicon.ico HTTP/1.1" 404 Not Found
   fastapi-redis-example-1  | INFO:     172.18.0.1:63998 - "GET / HTTP/1.1" 200 OK
   fastapi-redis-example-1  | INFO:     172.18.0.1:63998 - "GET / HTTP/1.1" 200 OK

Test
----

This application comes with the unit tests.

To run the tests do:

.. code-block:: bash

   docker-compose run --rm example py.test fastapiredis/tests.py --cov=fastapiredis

The output should be something like:

.. code-block::

   platform linux -- Python 3.10.9, pytest-7.2.0, pluggy-1.0.0
   rootdir: /code
   plugins: cov-4.0.0, asyncio-0.20.3
   collected 1 item

   fastapiredis/tests.py .                                         [100%]

   ----------- coverage: platform linux, python 3.9 -----------
   Name                          Stmts   Miss  Cover
   -------------------------------------------------
   fastapiredis/__init__.py          0      0   100%
   fastapiredis/application.py      14      0   100%
   fastapiredis/containers.py        6      0   100%
   fastapiredis/redis.py             7      4    43%
   fastapiredis/services.py          7      3    57%
   fastapiredis/tests.py            18      0   100%
   -------------------------------------------------
   TOTAL                            52      7    87%