Package: python-project-template-poetry
A project template for PythonIntroduction: This repository provides a comprehensive project template for GitHub repositories. It's designed to
streamline the setup process, ensuring best practices and essential components are included. By using this template, you
can ensure a consistent and professional structure for your projects, making them more accessible and maintainable.UsageCreate a new repository from this templateClick hereto create a new repository with this template.Select and Add a license.Initialize and installpre-commithooksInstallpre-commit. (skip this step if you already have pre-commit installed)Runpre-commit installto install the pre-commit hooks.Runmake pre-committo run the pre-commit hooks on all files.Setup GitHub Branch ProtectionGo toSettings>Branches>Branch protection rules>Add ruleAdd the following rules:mainRequire a pull request before mergingRequire status checks to pass before mergingRequire branches to be up-to-date before mergingAddlintingstatus checks ( and others if you created them )Do not allow bypassing the above settingsdevRequire a pull request before mergingRequire status checks to pass before mergingAddlintingstatus checks ( and others if you created them )Why Branch Protection?: Branch protection ensures that changes to important branches undergo a review process. This
maintains code quality and prevents potential issues from being merged.Branching Strategymain: The main branch. This branch is protected and cannot be pushed directly. (PRs must be made todevinstead
ofmain)dev: The development branch. This branch is protected and cannot be pushed directly. (PRs must be made to this
branch)feature/*: The 'feature/*' branches are used to develop new features for the upcoming or a distant future release.
These branches are branched off from 'dev' and must merge back intodev.release/*: The 'release/*' branches are used to prepare the next release. They allow for last-minute changes and
minor bug fixes. These branches are branched off from 'dev' and must merge back intomainanddev.hotfix/*: The 'hotfix/*' branches are used to develop fixes for the current release. These branches are branched off
frommainand must merge back intomain.How to create a python package with this template? (WIP)Create a new repository from this template. (
seeCreate a new repository from this template)Place your package code in thesrcdirectory.Update thepyproject.tomlfile with your package details.Set up your PyPI account and create a new API token. (seePyPI Help #api-token)Go toPyPIand create an account, if you don't have one already.Generate a PyPI API token. (seePyPI Help #api-token), this gives you something similar to this:runpoetry config pypi-token.pypi <your-api-token>to set the API token.runpoetry buildto build the package.runpoetry publishto publish the package to PyPI.ContributingContributions are always welcome! Whether it's bug reports, feature requests, or pull requests, all contributions are
appreciated. For more details, seeCONTRIBUTING.md.LicenseThis project is licensed under some License. For more details, seeLICENSE.Code of ConductWe believe in fostering an inclusive and respectful community. For guidelines and reporting information,
seeCODE_OF_CONDUCT.md.SecurityYour security is paramount. If you discover any security-related issues, please follow the guidelines
inSECURITY.md.FoundingFor information about the project's founding and backers, seeFOUNDING.