Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.17 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.17 KB

Cookiecutter PyPackage

Cookiecutter template for a Python package.

Features

  • Uses uv for dependency management and packaging.
  • Uses pre-commit hooks.
  • Deploys pdoc documentation via GitHub Pages.
  • Can be configured with a single call of make.
  • Strikes a balance between complexity and simplicity, tailored towards data scientists.

Development

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/thomascamminady/cookiecutter-uvpackage

Create a remote repository with the specified name and enable GitHub Actions as the deployment method for GitHub Pages.

Change into the new project folder and run:

make

And you're done!