Cookiecutter template for a Python microservice.
- Create a "ready to work" microservice project like our Microservice Scaffold
- Deploy your microservice with Microservice chassis pattern powered by PyMS, Flask, Connexion and Opentracing.
- Testing setup with
py.test - Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.6
- Mkdocs docs: Documentation ready for generation with, for example
Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
$ pip install --upgrade virtualenv
$ virtualenv env
$ source env/bin/activate
$ pip install -U cookiecutter
Generate a Python Microservice project:
(env) $ cookiecutter https://github.com/python-microservices/microservices-template.git
project_repo_url [https://github.com/python-microservices/microservices-scaffold]:
project_name [Python Microservices Boilerplate]: prueba descarga
project_folder [prueba_descarga]:
project_short_description [Python Boilerplate contains all the boilerplate you need to create a Python package.]:
create_model_class [y]:
microservice_with_swagger_and_connexion [y]:
microservice_with_traces [y]:
microservice_with_metrics [y]:
application_root [/prueba_descarga]:
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]:
virtualenv --python=python[3.6|3.7|3.8] venv
source venv/bin/activate
pip install -r requirements.txtpip install pipenv
pipenv installPipenv generates two files: a Pipfileand a Pipfile.lock.
Pipfile: Is a high level declaration of the dependencies of your project. It can contain "dev" dependencies (usually test related stuff) and "standard" dependencies which are the ones you'll need for your project to functionPipfile.lock: Is the "list" of all the dependencies your Pipfile has installed, along with their version and their hashes. This prevents two things: Conflicts between dependencies and installing a malicious module.
For a more in-depth explanation please refer to the official documentation.
python manage.py runserverYour default endpoints will be in this url:
http://127.0.0.1:5000/films/
http://127.0.0.1:5000/actors/This URL is set in your config.yml:
pyms:
config:
DEBUG: false
TESTING: false
APP_NAME: Template
APPLICATION_ROOT : "" # <!---You can acceded to a swagger ui in the next url:
http://127.0.0.1:5000/ui/This PATH is set in your config.yml:
pyms:
services:
swagger:
path: "swagger"
file: "swagger.yaml"
url: "/ui/" # <!---Read more info in the documentation page: https://microservices-scaffold.readthedocs.io/en/latest/
You can dockerize this microservice wit this steps:
- Create and push the image
docker build -t films -f Dockerfile . - Run the image:
docker run -d -p 5000:5000 films