Cookiecutter for python projects

• poetry dependency management/building
• linting with ruff
• type checking w mypy
• test with pytest
• Docs w/ mkdocs
  • mkdocs-material
  • mkdocs-jupyter
• Docs hosting with gh pages
• CI via github actions
• docker image build
• vscode devcontainer
• github codespaces compatible
• command running with just

Usage

Install cookiecutter

cookiecutter https://github.com/ecurtin2/cookiecutter-python

Answer the questions to finish generating the code, which will be in a new folder.

Run in local devcontainer

Install VSCode

cd my_project
code .

A Pop-up will show and ask you to run in a devcontainer, click Reopen in Container. You will then be editing code inside a running docker container of your project.

Run in github codespaces

You can also develop on a hosted container using github codespaces. You won't need to do any setup out of the box you will simply see a running vscode in the browser. Read their docs here for more information.

Commands

When developing you're probably going to want to test your changes locally before pushing. To run the same tests locally as in CI, use.

just ci

See the justfile for all available commands, or run

just --list

Users

If you use this cookiecutter, add yourself here :)

• https://github.com/ecurtin2/dagster_delta
• https://github.com/ecurtin2/algove