Home

Awesome

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:

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.