/pyconie-2019-cookiecutter

Cookiecutter template for PyConIE 2019 workshop.

Primary LanguagePython

Cookie Cutters

Templates for Cookiecutter!

In order to create a project from this cookie cutter, you'll need to install it. Once installed and this repo is cloned locally, you can check out how to generate a new project.

Presentation

Workshop Presentation

Templates

cookiecutter pyconie-2019-cookiecutter/base

User Input

On creation you will be prompted for the following information. Please take the time to carefully answer these as many of the values will be used in the service directory to help audit our services.

Name Choices Type Comments
event PyCon IE 2019 string Squad that owns the service
primary_maintainer Name for the primary maintainer string Primary directly responsible individual
app_name dialajoke string Name of the app
repo_name dial-a-joke string Name of Github repo
container_name dial-a-joke string Unique name of the container (and service)
project_short_description -- string High level summary of the service for the README

New Project Workflow

You're starting with a new project created via cookiecutter as above.

  • pip install -r requirements.txt

  • Testing/linting/etc. Invoke is included in requirements.txt and it provides an easier environment than Bash to control I/O from testing tools. When running inv or invoke, Invoke will search for a tasks module/package and execute commands from it.

    • Available commands: inv --list
    • Command details: inv <command> --help