:cookie: cookie-doh

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

:woman_shrugging: Why should I care?

• :seedling: Improve your development workflow, validity and readability of code for individual & collaborative projects!

• :scroll: Uses poetry for dependency management, virtual environments and packaging, i.e., code is readily importable!

• :tropical_drink: Takes less than a minute to create a fully pre-configured project!

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

:star: Star this repo to show your support!

:rocket: Getting started with cookie-doh

This template uses copier to create new repositories. If you don't have copier, follow the installation instructions.

Then, simply type

copier copy gh:microsoft/cookie-doh <new-repo-folder>

and answer the questions to create your new project.

Minimum required system dependencies are python >= 3.10 and poetry.

:notebook_with_decorative_cover: Documentation

Visit the documentation:

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

:point_right: Go to new project to get started!

:space_invader: Codespaces

We provide a configured devcontainer for you to use in your new project and/or cookie-doh itself. You can create a container image with all the necessary dependencies, and use it for remote development in a remote node with GitHub Codespaces or DevPod.

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

:gear: Devcontainer

Alternatively, you can build a local container directly and use it in VSCode and/or PyCharm without developing in a remote node or setting up a local environment.

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

:point_right: Follow instructions for VSCode and/or PyCharm.

:computer: Local development

The only required system dependencies are python >= 3.10 and poetry. However, we recommend installing some extra dependencies to improve the development experience.

:point_right: Follow instructions to set up your local environment.

:hammer_and_wrench: Development tools:

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

• Poetry for dependency management, virtual environments and packaging, i.e., makes your code readily importable!
• ruff for formatting and linting: helps you write clean and uniform code for better consistency (and it's fast!).
• pytest for testing: ensures your code is working as expected!
• pyright for static annotations: helps identify simple errors, but more importantly, 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 (when you create a new project):

• 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.

:mountain: 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.

:balance_scale: 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.