krocat / python_library_cookiecutter

cookiecutter, python, CI,

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python Library Template

Cookiecutter template for a Python library script.

Remember, when creating a library with this template, to:

  • Fill in all your requirements in requirements.txt
  • 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

About

cookiecutter, python, CI,

License:MIT License


Languages

Language:Python 58.1%Language:Makefile 28.3%Language:Shell 13.6%