hammerlab/cookiecutter-hammerlab

Name: cookiecutter-hammerlab

Owner: Hammer Lab

Description: A cookiecutter template for pip-installable python projects, specific to Hammer lab conventions

Forked from: wdm0006/cookiecutter-pipproject

Created: 2016-06-29 15:54:38.0

Updated: 2017-04-10 16:54:17.0

Pushed: 2017-08-30 19:32:26.0

Homepage:

Size: 42

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

CookieCutter Pip-Project

A cookiecutter template for python projects intended to be pip-installed

cookiecutter

Inspired by: sloria

Using CookieCutter for your project

$ pip install cookiecutter
$ cookiecutter https://github.com/hammerlab/cookiecutter-hammerlab.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used in your new project.

Publishing your project to pypi

There are two ways to publish your project:

• the manual way, outlined here
• and with pypi-publisher ppp

Goals

The goal of this project is simply to take some of the boiler plate out of creating a new python project. It is intended to stay pretty minimal, but contains best-practices in use by the Hammer Lab.

These projects at a minimum will include:

• Sphinx documentation
• Installable via pip in pypi
• Testing via Nose and Coverage
• Code linting via pylint
• Travis CI configuration

Contributing

The intent of this project is to stay fairly lean, but up to date with current best-practices in use by our lab.

License

BSD licensed.