cookie-doh¶

Cookie-doh is a repository template for creating single Python package projects that include pre-configured development tools.

Improve your development workflow (checks, formatting, remote dev, etc.).
Uses uv for dependency management (configured and fast).
quick and easy to start new projects!

Short-link: https://aka.ms/cookie-doh

Star this repo to show your support!

This template uses uv and copier to create new repositories:

curl -LsSf https://astral.sh/uv/install.sh | sh  # Install uv
uv tool install copier  # Install copier
copier copy gh:microsoft/cookie-doh <new-repo-folder>  # Create new project

Documentation¶

Visit the documentation:

https://microsoft.github.io/cookie-doh/

Go to new project for first steps!

Codespaces¶

Learn about GitHub Codespaces and DevPod.

Click below to clone or fork this repository automatically and start developing:

Devcontainer¶

Learn about Devcontainers. Requires Docker installed on your local machine.

Follow instructions for VSCode and/or PyCharm.

Local development¶

Follow instructions to set up your local environment.

Development tools¶

Cookie-doh uses and generates projects with the following tools to help the development experience:

uv for dependency management, virtual environments and packaging. Configured so that your code is readily importable.
ruff for formatting and linting: helps you write clean and uniform code across collaborations.
pytest for testing: ensures your code is working as expected.
pyright for static annotations: helps identify simple errors and makes your code more readable!
codespell for spell checking: pinpoints spelling errors across code and documents.
CI workflows: automates validation when you submit a PR or merge to main branch.

Optional tools (configurable when you create a new project):

Material for MkDocs for beautiful markdown documentation builds (like cookie-doh's).
pre-commit for quick validation checks and fixes before committing.
commitizen for writing conventional commits, to help write better commit messages and track changes through time.

Contributing¶

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks¶

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.