Getting Started
This project template codifies LINCC Framework’s best practices for python code organization, testing, documentation, and automation. It is meant to help python projects get started quickly and allow the user to focus on writing code.
We built this tool with a few assumptions in mind. The following are not considered requirements to use the template. However, some of the included tooling may not work as expected if your project doesn’t follow these guidelines.
Your project is mostly Python based.
GitHub will be used as a remote repository.
Your remote repository will be publicly available.
We have seen the template used successfully in projects that don’t adhere to these guidelines. But if you meet these guidelines, you’ll be guaranteed to get the full benefit of the template.
Prerequisites
To use our template you’ll need to install Copier. Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. It’s really neat!
Important
Copier has a few requirements and one recommended tool:
Python > 3.7 required
Git > 2.27 required
pip >= 22 required
pipx recommended
Learn how to maintain a clean Python environment with pipx
here. We recommend using pipx to install Copier
for a more maintainable development environment, although some users have also
had success with conda.
You can check your requirements like so:
>> python --version
Python 3.10.9
>> git --version
git version 2.34.1
>> pip --version
pip 23.3.1 from _____
>> which pipx
/usr/bin/pipx
Given that your system satisfies the requirements, go ahead and install Copier.
Important
This template is optimized to work well with Copier >= 9.1.0.
pipx list will display the currently installed version of Copier.
>> pipx install --force copier>9.1.0