arraial/pipo_dispatch repository overview

⁠pipo_dispatch

Pipo service responsible for forward hub requests to services

⁠Installation

⁠Runtime prerequisites

The application is compatible with Windows and Linux based systems. Docker⁠ + Docker Compose⁠ are assumed to be installed and configured.

⁠Development

One may leverage VS Code Devcontainer for a simplified setup or other suitable option, as describbed in Manual Setup⁠.

⁠Visual Studio Devcontainer

Devcontainer functionality can be used by choosing option Dev Containers: Open Folder in Container... in VS Code.

⁠Manual Setup

For these guiding steps a compatible version⁠ of Python is assumed to be installed.

In case poetry is not locally installed:

make poetry_setup

To setup the development environment and being able to run the test suite do:

make dev_setup

Build the app container image with:

make image

For additional help try:

make help

⁠How to run

⁠Test suite

Before running the suite make sure file /tests/.secrets.yaml was created and filled based on the available example⁠.

make test

⁠Containerized application

Before running the following command make sure .env was created and filled based on the available example⁠.

Start the container with

make run_image

⁠License

This project is licensed under the MIT License - see LICENSE⁠ file for details.