Skip to content

My second attempt at making a Python template. Formerly used CookieCutter; now uses Copier

License

Notifications You must be signed in to change notification settings

ThatXliner/pyt2

Repository files navigation

Note: If you're looking for the old CookieCutter template, see this branch

Pyt2

GitHub tag (latest SemVer release)

My second attempt at making a Python template.

Why?

I've seen many other projects like this but I've never seen any of them follow the pattern I want. I highly recommend you Fork This Project for your own needs because many of the defaults (e.g. README structure) are quite opinionated.

✨ Features

Usage

First, install Copier (preferably using pipx):

pipx install copier

Now you can run this command to create a new folder in the current directory that contains the scaffolded project:

copier copy gh:ThatXliner/pyt2 .

Or for the bleeding-edge version on the master branch:

copier copy gh:ThatXliner/pyt2 . --vcs-ref master

Updating a project

If you have already made a project using this and this template gets a new release, you may update your project by running

copier update

in your project.

FAQ

About the name...

Pronunciation: pit-too Why this is the name: Python Template 2

Why is the default templated license GPL?

Because it's usually better.

But you can fork this and modify the default license in the template anyways. This template, however, is released to the Public Domain.