Skip to content

Randers-Kommune-Digitalisering/api-service

Repository files navigation

Python app template projekt

Template til nye Python app projekter. Projekt indeholder en bare bone Flask app

  • healthz endpoint
  • unit test af healthz endpoint

Brug af python-app-template

  1. Klik på "use this template" og vælg "create a new repository"
  2. Udfyld skærmbillede med information om den nye service
  3. Åbn dit nye git projekt

Nyt Python app projekt

Nedenstående relaterer sig til et nyt Python app projekt der er baseret på denne template.

Udvikling i et Codespace:

  1. Gå til det nyoprettede repository i github.
  2. Klik på den grønne <>Code knap og vælg "create codespace on <branch>"
  3. Kør . ./setup-dev-linux.sh , scriptet sætter et virtual environment op og installerer pakkerne i app/requirements.txt og requirements-dev.txt

Udvikling lokalt:

  1. Gå til det nyoprettede repository i github.
  2. Klik på den grønne <>Code knap og kopier url'et, clone det med git: git clone <url>
  3. Kør . ./setup-dev-linux.sh (Linux) eller setup-dev-windows.bat (Windows), scriptet sætter et virtual environment op og installerer pakkerne i app/requirements.txt og requirements-dev.txt

Quick start

Almindelige commands

  • Start app'en: python src/main.py
  • Start app'en i docker container: docker-compose up
  • Unit tests: pytest
  • Unit tests med coverage pytest --cov=src
  • Lint: flake8 --ignore=E501 src tests --show-source

Logning

  • Logning til stdout, sat op i logging.py, kaldes i main
  • Logning gøres med logger og ikke print() functionen
  • Eksempel på brug af logger her, her og her
  • Prometheus: eksempel på gauge her og brugt her

Database

Skriv til filer

  • Hvis der skal skrives til filer skal det være på et eksternt mount
  • Eksempel til at test lokalt docker-compose.yml

Kør kode på bestemt tidspunkt eller med interval

TODO

  • deploy
  • frontend - new template

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 3

  •  
  •  
  •