Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 1.66 KB

README.md

File metadata and controls

84 lines (60 loc) · 1.66 KB

meteo-french-api

Meteo French API

Mission

Tech Specs

Read Tech Specs that document the specification and milestones of the API from development to deployment.

Run locally

Set environment variables secrets in a .env.secret file (check in the .env.dev file which ones are to be set)

Build the docker image and run the app locally with

./run_docker_local.sh

Now you can visit http://localhost:8000/docs to view the Swagger UI of the app (only available in dev environment)

Generate the OpenAPI spec

./run_docker_local.sh flask spec

The result is found at meteofrenchapi/openapi.yaml

Run Pylint on

python3 -m pylint meteofrenchapi *.py

Run unit tests

./run_docker_local.sh coverage run -m unittest discover meteofrenchapi
./run_docker_local.sh coverage report -m

Push docker image to registry

./push_docker.sh <registry/image_name>

Deploy in minikube

Test minikube and kubectl are installed

minikube version
kubectl version

Create a mfapi-secret.yaml file with required secrets with the following template

apiVersion: v1
kind: Secret
metadata:
  name: mfapi-secret
type: Opaque
data:
  SECRET_KEY: <pass_base64>
  ACCWEA_TOKEN: <pass_base64>

Note: The base64 encoding password can be generated with the following command : echo -n "password" | base64

Apply secret file:

kubectl apply -f mfapi-secret.yaml

Deploy application:

kubectl apply -f mfapi.yaml

View the API with the command minikube service mfapi-service.

Test the endpoints:

  • /prcpt?lt=48.870502&lg=2.304897
  • /uvidx?lt=48.870502&lg=2.304897