Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.04 KB

File metadata and controls

37 lines (25 loc) · 1.04 KB

Python Library Template

Cookiecutter template for a Python library script.

Remember, when creating a cli program with this template, to:

  • Fill in all your requirements in requirements.txt
  • Think about how you want to solve logging. The template has an command line option for a config file and will log to stdout when it's not set
  • If you add more packages (subdirectories) than the one you create your project for, add them to the packages in setup.py
  • Write tests for you software and put them in tests/
  • Document your project.
  • Write inline documentation to describe your classes and methods
  • Write a readme (./README.rst)
  • Write (a) usage example(s) (./USAGE.rst)
  • Keep a (global) changelog in ./HISTORY.rst

Development Requirements

These utilities / libraries are needed to start developing on with this template.

  • curl
  • make
  • cookiecutter
  • virtualwrapper
  • sphinx
  • setuptools

Usage

cookiecutter python_library_cookiecutter # answer the prompts... DONE