apm-service

Back-end service for APM.

Description

This is a brief template that provides the basic setup to create the backend portion using FastAPI. The documentation of the API is done using SwaggerUI, and Pydantic is used for data validation and setting management.

Dependencies

• Python 3.12.3

🏃 Running Locally

Preparation:

1. Setup a virtual environment (conda, venv, etc).
2. Run pip install -r requirements.txt to install necessary packages.
3. Create an env file named .env in the project root path and add the following environment variables:

    ACCESS_TOKEN_SECRET_KEY
    ACCESS_TOKEN_VALIDITY_MINUTES
   
    DB_NAME
    DB_HOST
    DB_PORT
    DB_USERNAME
    DB_PASSWORD
   

Set up local PostgreSQL DB:

1. Start container with docker-compose -f cicd/docker-compose.yml up -d.
2. Stop container with docker-compose -f cicd/docker-compose.yml down -v.

Running:

1. Run service with uvicorn app.main:app --host 0.0.0.0 --port 8888 --reload.
2. Check code style with flake8.
3. Run tests and mypy check with coverage run -m pytest --mypy -s.
4. Check coverage with coverage report.