Skip to content

<Minimal> Cookiecutter template for a Python package. Highly opinionated to use conda and pytest, without pip.

License

Notifications You must be signed in to change notification settings

openSourcerer9000/cookiecutta

 
 

Repository files navigation

Cookiecutter PyPackage

Updates Build Status Documentation Status

Minimal Cookiecutter template for a Python package. Highly opinionated to use conda and pytest, without pip. Basically forked the Audrey Feldroy template and removed a lot of stuff.

Conda Build

Conda build boilerplate is a bit tricky, so a bit of research, trial and error went into getting the conda-recipe folder set up. To build:

  • specify python versions in both conda-recipe/conda_build_config.yaml and setup.py.
  • specify required dependencies in conda-recipe/meta.yaml requirements.run.
  • $ cd conda-recipe
  • $ conda build
  • etc

Features

  • Conda setup in the conda-recipe folder
  • pytest
  • Sphinx docs: Documentation ready for generation with, for example, Read the Docs

Build Status

Linux:

Linux build status on Travis CI

Windows:

Windows build status on Appveyor

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/openSourcerer9000/cookiecutta.git

Then:

  • Create a repo and put it there.
  • Add the repo to your Travis-CI account.
  • Install the dev requirements into a virtualenv. (pip install -r requirements_dev.txt)
  • Register your project with PyPI.
  • Run the Travis CLI command travis encrypt --add deploy.password to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
  • Add the repo to your Read the Docs account + turn on the Read the Docs service hook.
  • Release your package by pushing a new tag to master.
  • Add a requirements.txt file that specifies the packages you will need for your project and their versions. For more info see the pip docs for requirements files.
  • Activate your project on pyup.io.

For more details, see the cookiecutter-pypackage tutorial.

Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

  • Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
  • It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

Or Submit a Pull Request

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.

About

<Minimal> Cookiecutter template for a Python package. Highly opinionated to use conda and pytest, without pip.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 92.0%
  • Batchfile 4.5%
  • Makefile 3.2%
  • Shell 0.3%