REST API that given a Pokemon name return its Shakespearean description

📝 NOTE

The app use externals api services:

• pokeapi
• shakespeare translator

While the pokeapi service is free, the Shakespeare translator service is not.
So the project use the free plan that is limited to 60 API calls a day with distribution of 5 calls an hour

💬 Description

I organized the project task with GitHub issues. You can check the project board here
A CI is set up with GitHub actions that checks for:

• Commit message pattern
• Linting
• Tests

NOTE: The CI runs only unit-tests because of the limitation of the free plan of the shakespeare translator service

🚀 Deploy (CD)

The PokeSpeare API is deployed to Heroku with a CD GitHub action for every push on master.
The API is reachable at https://pokespeare-api.herokuapp.com and HERE you can access the swagger

📦 Docker

You can run the application in a docker container

Requirements

• install docker

To build the app, you can run the following command from the root of the project:
make docker-build

After you built it, you can run it:
make docker-run
The app is now up and running at localhost:8080 and you can access the swagger at localhost:8080/docs

After closing the app, you can run make docker-rm to remove the container

💻 API Usage

When the app is up, you can ask for a Shakespearean translation of a pokemon description
Using httpie for example or any other http client
The following GET endpoint is exposed: /pokemon/<pokemon-name>

🔨 Development

You can also run the app, tests, linter, etc... without docker to facilitate local development

Requirements

• poetry python dependency manager
• python 3.8+

List of possible commands:

• make install-dependencies to create the virtual env and install al the project dependencies
• make lint to run the linter
• make unit-tests: to run all the unit tests of the project with coverage report
• make tests to run all the tests (integration included)
• make dev to run the application locally with auto reload reachable at localhost:8080 or localhost:8080/docs for the swagger

✏️ Contributing

We use conventional commits with the issue id at the end of the commit message within brackets
example:
feat: my new amazing feature (#87)

NOTE: a commit message checker step in the CI step will ensure that the commit message follows these rules