This is a template repository for Python projects that use Poetry for their dependency management. It has been generated from the cookiecutter-poetry repo. Unfortunately it is not maintained anymore. Therefore, this repo.

• Github repository: https://github.com/vkuehn/python-try/
• Documentation https://vkuehn.github.io/python-try/

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin [email protected]:vkuehn/python-try.git
git push -u origin main

Finally, install the environment and the pre-commit hooks with

python3 -m venv .venv
source ./venv/bin/activate
pip install -U pip
pip install -r requierments.txt
make install

Make sure.

• that github pages is enabled for your repo in github.com/yourname/reponame/settings/pages.
• that you may need to give the GITHUB_TOKEN write permission. Go to your repository's Settings > Actions > General > Workflow Permissions and select Read and write permissions.
• before actively using make sure you get your first minor release version.
• rename everything python_try to your reponame

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

• see makefile for options during development
  • mkdocs generates source code documentation see mkdocs.yml
  • poetry builds project and dependencies
• pre commit hook see .pre-commit-config.yaml
  • case conflict
  • merge conflicts
  • check toml
  • check yaml
  • fix end of files
  • trim trailing whitespaces
  • fix README.md
  • run ruff
  • run prettier
• Pipelines
  • on-release-main - use mkdocs to publish documentation on GitPages more to come once I understand all of it

these from the original repo do not yet work To finalize the set-up for publishing to PyPi or Artifactory, see here. To enable the code coverage reports, see here.