Starting any project from scratch can be a daunting task... But not if you have this ultimate Python project blueprint!
Based on the "RESTful API" category.
Alternatively, view Blueprint/Boilerplate For Python Projects alternatives based on common mentions on social networks and blogs.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Blueprint/Boilerplate For Python Projects or a related project?
Build, Test and Lint Action Push Action Test Coverage Maintainability Quality Gate Status
You can find more information about this project/repository and how to use it in following blog post:
To use this repository as starter for your project you can run configure_project.sh script, which sets up all variables and file names. This way you can avoid configuring and renaming things yourself:
./configure_project.sh MODULE="coolproject" REGISTRY="docker.pkg.github.com/martinheinz/repo-name"
~ $ make run
Development image:
~ $ make build-dev
~ $ docker images --filter "label=name=blueprint"
REPOSITORY TAG IMAGE ID CREATED SIZE
docker.pkg.github.com/martinheinz/python-project-blueprint/blueprint 3492a40-dirty acf8d09acce4 28 seconds ago 967MB
~ $ docker run acf8d09acce4
Hello World...
Production (Distroless) image:
~ $ make build-prod VERSION=0.0.5
~ $ docker images --filter "label=version=0.0.5"
REPOSITORY TAG IMAGE ID CREATED SIZE
docker.pkg.github.com/martinheinz/python-project-blueprint/blueprint 0.0.5 65e6690d9edd 5 seconds ago 86.1MB
~ $ docker run 65e6690d9edd
Hello World...
Test are ran every time you build dev or prod image. You can also run tests using:
~ $ make test
~ $ docker login docker.pkg.github.com --username MartinHeinz
Password: ...
...
Login Succeeded
~ $ make push VERSION=0.0.5
Clean Pytest and coverage cache/files:
~ $ make clean
Clean Docker images:
~ $ make docker-clean
Application can be easily deployed on k8s using KinD.
To create cluster and/or view status:
~ $ make cluster
To deploy application to local cluster:
~ $ make deploy-local
To get debugging information of running application:
~ $ make cluster-debug
To get remote shell into application pod:
~ $ make cluster-rsh
To apply/update Kubernetes manifest stored in k8s directory:
~ $ make manifest-update
-Dsonar.projectKey= and -Dsonar.organization=
sonar-project.properties filesonar-scanner commandSONAR_TOKENToken is needed for example for GitHub Package Registry. To create one:
secrets.NAMEDo not miss the trending, packages, news and articles with our weekly report.