Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.51 KB

README.md

File metadata and controls

79 lines (60 loc) · 3.51 KB
Raw

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:

🛠️ Getting Started

  1. Install cruft with:

    python -m pip install cruft

  2. Run cruft with:

    cruft create https://github.com/cthoyt/cookiecutter-snekpack

  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 pyroma
    • Testing of MANIFEST correctness with check-manifest
    • Testing of optional static typing with mypy
    • Version management with bump-my-version
    • Building with uv build
    • Releasing to PyPI with uv publish
  • A command line interface with click
  • A vanity CLI via python entrypoints
  • A py.typed file so other packages can use your type hints
  • Automated running of tests on each push with GitHub Actions
  • Configuration for ReadTheDocs
  • A good base .gitignore generated from gitignore.io.
  • A pre-formatted README with badges
  • A pre-formatted LICENSE file with the MIT License (you can change this to whatever you want, though)
  • A pre-formatted CONTRIBUTING guide
  • A copy of the Contributor Covenant as a basic code of conduct

Attribution

Feel free to adapt this template to your needs, but please credit me in your README and link back to https://github.com/cthoyt/cookiecutter-snekpack.

⚖️ License

This cookiecutter package is licensed under the MIT License.