README.md

PYTHON TEMPLATE

Base template repository for python projects.

To get started, you can use this template from the repository on github. This will create a new repository with this template as base structure.

When the repository will be created, a cleanup action will be triggered and will remove all template related name by the new repository informations. The following changes will be applied :

• All the following will be replaced by your repository's name in snake case :
  • The code source directory (currently "python_template")
  • All occurences of python_template in the pyproject.toml file and the .vscode launch configs.
• The README subtitle and the pyproject.toml will be replaced by your repository description
• All mentions of the author will be replaced by the repository owner's github name
• All github urls will be updated to match the new repository urls

The cleanup action will be triggered once and then all related files will be deleted (including the action). If an error occures during the process, please report an issue for the problem to be fixed as soon as possible.

---

Technos : Python, Poetry

Author : Anatole de Chauveron

---

Summary

• Summary
• Requirements
  • Git
  • Python 3.8.10
  • Poetry
  • VSCode (Optional)
• Install the project
  • Clone the repository
  • Install the dependencies

Requirements

Git

git --version
# git version 2.34.1

Python 3.8.10

python --version
# Python 3.10.12

Poetry

poetry run --version
# Poetry (version 1.6.1)

VSCode (Optional)

This template is configured to work with the VSCode editor, but it does not required it to be used.

Install the project

Clone the repository

git clone https://github.com/Anatole-DC/template_python
cd template_python

Install the dependencies

poetry shell
poetry install

In dev mode :

poetry install --with dev