Skip to content

falkben/cookiecutter-pypackage

 
 

Repository files navigation

Cookiecutter PyPackage

Barebones cookiecutter for python packages

Installation

  1. Create a virtual environment & activate

    python -m venv .venv && source .venv/bin/activate

  2. Install this package

    pip install . -r requirements.txt

    Or for dev mode:

    pip install -e ".[dev]" -r requirements.txt -r requirements_dev.txt

Usage

Create a package with

cookiecutter .

Features

Creates a new project with the following configurations

  • package configured w/ pyproject.toml
  • dependencies managed with pip-tools
  • tests using pytest
  • CI configuration for GitHub Actions
  • MIT License
  • pre-commit hooks
    • black
    • flake8
    • isort

Testing

Make sure dev dependencies are installed

pip install -r requirements_dev.txt

Test with:

pytest

About

Cookiecutter template for a Python package.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 90.7%
  • Shell 9.3%