zsilver1/cookiecutter-grpc-python

cookiecutter-grpc-python

Powered by Cookiecutter, Cookiecutter gRPC Python is a framework for jumpstarting production-ready gRPC Python projects quickly.

Features

• Makefile
• Docker-compose
• .gitignore
• README.md
• cookiecutter-options.yml
• tests for cookiecutter
• Python client
  • base client
  • client keepalive
  • channel ready (reconnects if connection dropped)
  • client tests
• Server
  • Healthcheck
  • System Info
  • tests for gRPC service
  • server keepalive
  • Dockerfile
  • docker base image choice
  • endpoint decorator
  • logging framework
  • log server start
  • log endpoint call
  • log level from env var
  • certificates for local development

Usage

First, get Cookiecutter:

$ pip install cookiecutter

Alternatively, you can install cookiecutter with homebrew:

$ brew install cookiecutter

Finally, to run it based on this template, type:

$ cookiecutter https://github.com/lieutdan13/cookiecutter-grpc-python

If you want to re-apply the changes to this cookiecutter, run:

$ cookiecutter https://github.com/lieutdan13/cookiecutter-grpc-python --config-file [location_of_your_project]/cookiecutter-options.yml -f [parent_directory_of_your_project]

options

You will be asked about your basic info (name, project name, app name, etc.). This info will be used to customize your new project.

Warning: After this point, change all default options to your own information.

Answer the prompts with your own desired options.

full_name [John Doe]: 
project_name [gRPC Python]: 
project_slug [grpc-python]: 
app_name [grpc_python]: 
project_short_description [A gRPC service powered by Python.]: