Skip to main content

A task runner that works well with poetry.

Project description

Poe the Poet

Poe the Poet

PyPI version PyPI version PyPI version PyPI version

A batteries included task runner that works well with poetry.

📖 Read the documentation 📖


Quick start

  1. Install the Poe the Poet via pipx or another method.
pipx install poethepoet
  1. Define some tasks in your pyproject.toml
test         = "pytest --cov=my_app"                         # a simple command task
serve.script = "my_app.service:run(debug=True)"              # python script based task = "ssh -N -L$PROD:8080 $PROD &"   # (posix) shell based task
  1. Run your tasks via the CLI
$ poe test -v tests/unit # extra CLI arguments are appended to the underlying command
Poe => pytest --cov=my_app

If you're using poetry, then poe will automatically use CLI tools and libraries from your poetry managed virtualenv without you having to run poetry run or poetry shell

Poe can also be used without poetry.


There's plenty to do, come say hi in the discussions or open an issue! 👋

Also check out the CONTRIBUTING guide 🤓



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

poethepoet-0.23.0.tar.gz (49.7 kB view hashes)

Uploaded source

Built Distribution

poethepoet-0.23.0-py3-none-any.whl (64.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page