https://github.com/mrjk/python-project-poetry-template
A python project template with Poetry
https://github.com/mrjk/python-project-poetry-template
lang-python mrjk-template poetry python semver
Last synced: 2 months ago
JSON representation
A python project template with Poetry
- Host: GitHub
- URL: https://github.com/mrjk/python-project-poetry-template
- Owner: mrjk
- Created: 2022-11-11T19:42:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T06:43:41.000Z (over 3 years ago)
- Last Synced: 2025-12-17T01:36:56.481Z (6 months ago)
- Topics: lang-python, mrjk-template, poetry, python, semver
- Language: Shell
- Homepage: https://mrjk.github.io/python-project-poetry-template/latest/
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Python Project Poetry Template
This is a template of a python project with all CI/CD tools implemented.
## Features
* `direnv` support
* `commitizen` support
* `pre-commit` support
* Github Actions support
* Version bumping support
External requirements:
* direnv
* task
* git-flow
## Understand how it works
Making new releases with git is not that simple. Actually, this mechanism with the current tools we have does not
really support well nomenclature change in the git history. If you want to experiment, you may want to sometime
reset your git history to start from a fresh clean.
## Howto
### Completely reset the project
Locally:
* # git clone REPO -b RESET
* git clone git@github.com:mrjk/python-project-poetry-template.git -b main RESET
* cd RESET
* rm -rf .git
* git init .
* git add .
* git commit -m "Initial commit"
On github (if you want to clean actions and releases as well):
* Delete your repository
* Recreate your repo with the same name
* Ensure in the settings:
* Settings/Actions/General
* Check: Allow all actions
* Settings/Pages
* Check: Deploy from branch
* Branch: gh_page
* Dir: / (root)
Finally, locally:
* git remote add origin git@github.com:/.git
* git push -u --force origin master