This is a project made at work, of which the .git folder has been removed to delete any records of sensible information (like credentials) of the past, that way this doesn't violate any conditions! The responsibility of this microservice is to comply to a standard, named and defined as MessageDTO (specified with the help of Pydantic in src/schemas/message_dto.py), so a certain number of fields is expected in an exact way at /v1/messages. These fields are looked up into the POSTed request's body. In the documentation (more details further below) plenty of valid examples are included!

• Docker
• Pipenv
• Unittest
• Pytest
• Make

To deploy to any of the current environments, first you will have to create a properly written .env file in src/. To know what to write in it, there's an .envtemplate file that provides the correct guidance!

In production though, you would usually prefer to not write an .env file but to write the env variables in a yml file instead.

$ docker image build --tag testing:1 .
$ docker container run --publish 8001:8001 --rm -it testing:1

These commands will install the dependencies and start a local development server.

$ pipenv shell
$ pipenv install
$ make dev

$ make tests

$ make coverage

There's a make statement that uses mypy, flake8, and pylint to check the code recursively. This project is entirely typed and mypy compliant.

$ make check

Go to localhost:8001/docs and you will see plenty of examples to test out!

This project is fully documented and 100% test-covered.