/cookiecutter-python

Personal cookiecutter template for Python packages

Primary LanguagePythonMIT LicenseMIT

cookiecutter-python

GitHub license

Personal cookiecutter template for Python packages.

Install

  1. Install git
  2. Install Python
  3. Install cookiecutter via pip
pip install cookiecutter

Usage

  1. Create the python package template as a folder cookiecutter gh:rrwen/cookiecutter-python
  2. You will be prompted to fill in user input for the template
  3. Change directory to the generated folder cd <name>
  4. Create an empty Github repository through the Github interface with the same name as the package name
  5. Initialize the Github repository by running bin/init_github.sh or bin/init_github.bat
  6. See Developer Notes for details on the files and folders generated, as well as hosting a documentation web page

In Linux/Mac OS:

cookiecutter gh:rrwen/cookiecutter-python
cd <name>
source bin/init_github.sh

In Windows:

cookiecutter gh:rrwen/cookiecutter-python
cd <name>
bin\init_github.bat

Note: Replace <name> with the python package name that you gave during the user input prompt