Welcome to Store Api

Readme WIP

Examples can be found here https://leankit.com/learn/kanban/kanban-board/

Requirements

The project requires Python 3.12 or higher and the Poetry package manager.

Useful Python commands

Installation

After installing poetry, install the project dependencies with:

poetry install --with ci,tests

This will install main dependencies together with optional ones. For more information see optional groups settings.

Run the tests

Run all tests

poetry run pytest

Run the application

Run the application which will be listening on port 8020.

poetry run python app.py

Pre-commit hooks

The project is offering pre-commit hooks, please install them via

pre-commit install

GitHub Actions

Each commit in the main branch will trigger a pipeline which will run unit tests and different linting tools. When successful it will also containerize the application, finally its scans the docker image for vulnerabilities with Trivy.

Building Docker Image

The application can be containerized by using:

docker build -t store-api .

Building Docker image

Once the docker image is built, it can be run with:

docker run -p 8020:8020 store-api

API

Below is a list of API endpoints with their respective input and output. Please note that the application needs to be running for the following endpoints to work. For more information about how to run the application, please refer to run the application section above.

Autogenerated documentations

The application will automatically generate documentations and provide them under:

• Swagger UI > http://localhost:8020/docs
• ReDoc > http://localhost:8020/redoc