Create a new repo from the template#

Once you have followed the Install template pre-requisites tutorial, you can use copier to make a new project from the template:

$ mkdir /path/to/my-project
$ copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/my-project

This will:

Ask some questions about the project to be created
Expand the template with the answers give
Record the answers in the project so they can be used in later updates
Create a git repository if the directory is not already one

Committing the results#

You can now check what the template has created, tweak the results if desired, and commit the results:

$ cd /path/to/my-project
$ git add .
$ git commit -m "Expand from python-copier-template x.x.x"

Uploading to GitHub#

You can now create a new blank project on GitHub. Choose the same GitHub owner and repo name that you answered in the questions earlier. GitHub will now give you the commands needed to upload your repo from GitHub

Settings#

You can now go to the cogwheel on the main page next to the “About” header, and set the project description to match the answer you gave.

Then go to the Settings tab and set:

Enable Pages if you chose to use sphinx for your documentation

Getting started with your new repo#

You can now Setup Developer Environment, and then follow some of the other How-to Guides.