Usage¶

Create a Virtual Environment¶

It’s a good practice to create a virtual environment for your project. Here’s how you can do it:

python -m venv .env
# On Windows
.\.env\Scripts\activate
# On macOS/Linux
source .env/bin/activate

Install Copier¶

First, install Copier:

pip install copier

Generate a New Project¶

To generate a new project from this template, run:

copier copy git+https://dev.azure.com/initions-consulting/CLOE/_git/cloe-package-template-py path/to/destination

Replace path/to/destination with your desired project directory. Copier will prompt you for various options defined in the template.

Update an Existing Project¶

If you need to apply updates from the template to an existing project (e.g., you have cloned an existing remote repository), navigate to the root of your project directory and run:

copier update

This will update your project files according to the latest template while preserving your custom changes where possible.