cookiecutter-template

Richard Wen
rrwen.dev@gmail.com

Personal Python cookiecutter base template.

Install

1. Install Python
2. Install cookiecutter via pip
3. Install Node.js

pip install cookiecutter

Usage

Create a cookiecutter template:

cookiecutter gh:rrwen/cookiecutter-template

See Implementation for more details.

Developer Notes

Create Github Repository

1. Ensure git is installed
2. Change directory to the generated folder cd <template_name>
3. Initialize the repository
4. Add the generated files to commit
5. Create an empty Github repository with the same name as template_name
6. Pull any changes if the Github repository is not empty
7. Push the commit from 4. to your created Github repository

git init
git add .
git commit -a -m "Initial commit"
git remote add origin https://github.com/<github_user>/<template_name>.git
git pull origin master --allow-unrelated-histories
git push -u origin master

Implementation

This code creates folders and files for cookiecutter templates.

• The main file is cookiecutter.json which defines the inputs for the command line interface
• The inputs then replace any values surrounded with {{}} inside the folder {{cookiecutter.template_name}}

        cookiecutter              <-- template tool
             |
      cookiecutter.json           <-- template inputs
             |
{{cookiecutter.template_name}}    <-- generated template

The following files will be created inside a folder with the same name as the template_name input:

File	Description
{{cookiecutter.template_name}}	Templating folder with README.md and MIT LICENSE files
.gitignore	A Python .gitignore automatically generated from github
.travis.yml	A .travis.yml file for automatic builds and tests
LICENSE	MIT license file automatically created from github
README.md	A readme Markdown file with header, install, usage, and developer notes sections