This is a repository template specialzied on Python development. It comes with:
- Ruff for Linting & Formatting
- Pytest for Unit testing
- MkDocs with mkdocstrings for documentation generation
- GitHub Actions for PyPi publishing, Linting and Documentation
pyproject.tomlpre-configured- Documentation will be automatically hosted on GitHub Pages
Table of Contents
PROJECT_LONG_DESCRIPTION
START_INFO
Make sure to have Python 3.10+ installed on your system.
You can install as a Python Module using pip
or executing, if applicable, the script directly.
- If you want to install as a Python Module:
- Install the module using pip:
pip install PACKAGE_NAME
- Install the module using pip:
- If you want to use the script directly:
-
Clone the repository anywhere on your pc:
git clone https://github.com/LightDestory/PythonRepoTemplate -
Install the requirements using
pip(create avenvif you want):pip install . -e
-
USAGE_INFO
NOTES_INFO
If you are interested in contributing, please refer to Contributing Guidelines for more information and take a look at open issues. Ask any questions you may have and you will be provided guidance on how to get started.
Thank you for considering contributing.
If you find value in my work, please consider making a donation to help me create, and improve my projects.
Your donation will go a long way in helping me continue to create free software that can benefit people around the world.
The content of this repository is distributed under the GNU GPL-3.0 License. See LICENSE for more information.
