Python project template

Introduction

This is a project template based on copier. It will conditionally generate a new project files and directories using user's answers to a set of questions, dynamically replacing values in templated files. See copier's documentation for more information.

Creating a new project

Install copier, if needed:

pip install copier

and use it to create the project. It will ask you several questions, starting with the project name.

copier copy https://github.com/nova-sdk/nova-application-template.git project_folder

Updating project from template

This information is included in the autogenerated project's README file. But we repeat here as well:

Just enter the project folder, make sure git status shows it clean, and run:

copier update

See here for more information.

Local testing

For development purposes, one can (and probably have to) create a project out of the template to make sure it looks how it should be.

Just call copier copy --vcs-ref=HEAD command with a path to the local folder with this repository. We do this in CI/CD pipeline (via Docker) when we run tests.

copier copy path_to_this_project test_project --vcs-ref=HEAD