Skip to content
Cookiecutter template for a pyOpenSci Python package.
Python Makefile Batchfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
hooks
tests
{{cookiecutter.project_slug}}
.editorconfig
.gitignore
.travis.yml
CONTRIBUTING.rst
LICENSE
Makefile
README.rst
appveyor.yml
cookiecutter.json
pytest.ini
requirements_dev.txt
setup.cfg
setup.py
tox.ini

README.rst

Cookiecutter pyOpenSci

https://travis-ci.org/pyOpenSci/cookiecutter-pyopensci.svg?branch=master https://ci.appveyor.com/api/projects/status/github/pyOpenSci/cookiecutter-pyopensci?branch=master&svg=true

Cookiecutter template for a pyOpenSci Python packge.

Features

  • Tox and pytest testing: Setup to easily test for Python 2.7, 3.4, 3.5, 3.6
  • Travis-CI: Ready for Travis Continuous Integration testing
  • codecov: Code coverage report and badge using codecov and Travis
  • Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
  • Bumpversion: Pre-configured version bumping with a single command
  • Auto-release to PyPI when you push a new tag to master (optional)

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher)

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/pyOpenSci/cookiecutter-pyopensci.git

For more details, see the `cookiecutter-pyopensci tutorial <https://cookiecutter-pyopensci.readthedocs.io/en/latest/tutorial.html>`__

You can’t perform that action at this time.