Pipenv Cookiecutter

Deprecation warning

This project is deprecated in favor of using Poetry for package management. See jevandezande/poetry-cookiecutter

Intro

Cookiecutter for setting up pipenv projects with all of the below features.

Features

Testing with pytest
Formatting with black
Import sorting with isort
Static typing with mypy
Linting with flake8
Git hooks that run all the above with pre-commit
Continuous Integration with GitHub Actions
Code coverage with Codecov

Setup

While all of the steps are automated, you will need to install pipenv. Additionally, pipx is recommended for installing any command line tools.

python3 -m pip install pipx
pipx ensurepath

# Install pipenv using pipx
pipx install pipenv

# Use cookiecutter to create project from this template
pipx run cookiecutter gh:jevandezande/pipenv-cookiecutter

The cookiecutter will automagically

Generate a repo with the input configuration
Initialise git
Install dependencies
Setup pre-commit and pre-push hooks
Make initial commit

Recommendations

Make a cookiecutter.yml configuration file (see template_config.yml) with your default settings and use it with the flag --config-file cookiecutter.yml