Python Software Template

Easily start-up a repository for your python software projects. Note that this won't be the best of for libraries or packaged apps.

Table of Contents

• Python Software Template
• Table of Contents
• Install
• Usage
• Docs
• Contributing
• License

Install

This requires the latest version of UV installed, check this link to the installation process

Clone this repository to your computer using the following code, and that's it!

git clone https://github.com/caio-pavesi/python-software-template.git

Usage

After cloning this you can just hit ctrl+b and vscode will run the nescessary scripts to prepare the repository with a virtual environment based on the correct python version, the required libraries, and a variables file.

Docs

I'm still working on them, but you'll find them in the docs folder and in the github wiki.

Contributing

If you're using this template and you find any bugs, please do insert them into the GitHub issues. And if you want to contribute to the code speak to me directly via e-mail and adhere to the following standards:

• https://semver.org/
• https://keepachangelog.com/en/1.1.0/
• https://github.com/RichardLitt/standard-readme
• https://www.conventionalcommits.org/en/v1.0.0/

License

MIT © Caio Pavesi.