{"repo":"cthoyt/cookiecutter-snekpack","free":true,"listed":false,"github":"https://github.com/cthoyt/cookiecutter-snekpack","clone":"git clone https://github.com/cthoyt/cookiecutter-snekpack.git","description":"🍪 A cookiecutter package for an enlightened python package","language":"Python","stars":40,"topics":["cookiecutter","cookiecutter-python3","cookiecutter-python","cookiecutter-snekpack","cookiecutter-template","python","template"],"license":"MIT","category":"dev-tools","readme_excerpt":"Cookiecutter Snekpack A cookiecutter for making new Python repositories. This template is different from @audreyfeldroy's cookiecutter-pypackage because it uses the source layout and has lots of code quality assurance checks built in. If you're looking for something similar but not quite like this, try her package or see her list of alternatives. I've written several blog posts outlining all the ideas that made it into this template: - Blog: Flake8 - Blog: Packaging - Blog: CLIs - Blog: CLIs and Flask 🛠️ Getting Started 1. Install cruft with: or old-style using pip : 2. Run cruft with: 3. Enter the requested information, then win! Remember, package names should only have letters, numbers, and underscores. 4. If you're working under version control, copy the repository into your folder tracked under git, commit the files, and push to your remote. You can see an example repository of what happens right after you run these commands at https://github.com/cthoyt/snekpack-demo. 💪 Features Your new python package will have the following: - Standard src/ layout - Declarative setup with pyproject.toml (following PEP 621) - Reproducible workflows configured with tox or nox - Reproducible tests with pytest and - Reproducible notebooks with treon - Documentation build with sphinx 8.0+ and sphinx-rtd-theme 3.0+ - Testing of code quality with ruff - Testing of documentation coverage with docstr-coverage - Testing of documentation format - Testing of package metadata completeness with pyr","default_branch":null,"files":null,"tree":[],"storefront":"/r/cthoyt","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/cthoyt/cookiecutter-snekpack/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}