This is a template repository for Python projects that use Poetry for their dependency management.
- Github repository: https://github.com/tgran2028/search-operators/
- Documentation https://tgran2028.github.io/search-operators/
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]:tgran2028/search-operators.git
git push -u origin main
Finally, install the environment and the pre-commit hooks with
make install
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.
To finalize the set-up for publishing to PyPi or Artifactory, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.
- Create an API Token on Pypi.
- Add the API Token to your projects secrets with the name
PYPI_TOKEN
by visiting this page. - Create a new release on Github.
Create a new tag in the form
*.*.*
.
For more details, see here.
Repository initiated with fpgmaas/cookiecutter-poetry.