pentatester/github-poetry-starter

GitHub Actions starter for python with python-poetry.

Github Poetry Starter

GitHub Actions starter for python with python-poetry.

The complete documentation of python-poetry is available on the official website.

• Github Poetry Starter
  • Usage
  • Bumps version
  • Publish to pypi
    • Publish localy
    • Publish with github action
  • Dependency
    • Update dependencies
    • Install dependency
    • Remove dependency
    • Export requirements.txt

Usage

• Use this template
• Install poetry
• Run poetry install --no-root
• Run python init.py
• You Finished, happy coding!

Bumps version

Bumps the version of the project and writes the new version back to pyproject.toml if a valid bump rule is provided.

poetry version minor

The new version should ideally be a valid semver string or a valid bump rule: patch, minor, major, prepatch, preminor, premajor, prerelease.

Publish to pypi

You need to have PyPI account.

Publish localy

poetry publish --build

Publish with github action

Add PYPI_USERNAME and PYPI_PASSWORD to your Actions secrets, learn more.

Then create a release.

You need to create a release everytime bump to the new version.

Dependency

Update dependencies

poetry update

Install dependency

poetry add requests

For dev requirement

poetry add requests --dev

Remove dependency

poetry remove requests

For dev requirement

poetry remove requests --dev

Export requirements.txt

-o for output.

poetry export -f requirements.txt -o requirements.txt --without-hashes

For dev requirements

poetry export -f requirements.txt -o requirements-dev.txt --dev --without-hashes