Skip to main content

A task runner that works well with poetry and uv.

Project description

Poe the Poet

Poe the Poet

Python versions PyPI version Download stats License

A batteries included task runner that works well with poetry or uv.

📖 Read the documentation 📖


Features

Quick start

  1. Install the Poe the Poet globally via pipx or another method.
pipx install poethepoet

Or add it as a poetry project plugin:

[tool.poetry.requires-plugins]
poethepoet = ">=0.35"
  1. Define some tasks in your pyproject.toml
[tool.poe.tasks]
test         = "pytest --cov=my_app"                         # a simple command task
serve.script = "my_app.service:run(debug=True)"              # python script based task
tunnel.shell = "ssh -N -L 0.0.0.0:8080:$PROD:8080 $PROD &"   # (posix) shell based task

# A more complete example with documentation and named arguments
[tool.poe.tasks.count-incomplete]
help = "Count incomplete tasks in DynamoDB"
cmd  = """
aws dynamodb scan --table-name tasks
                  --select "COUNT"
                  --filter-expression "status >= :status"
                  --expression-attribute-values '{":status":{"S":"incomplete"}}'
                  --no-cli-pager
"""
args = [
  # Allow $AWS_REGION to be overridden with a CLI option when calling the task
  {name = "AWS_REGION", options = ["--region", "-r"], default = "${AWS_REGION}"}
]
  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 or uv, then poe will automatically use CLI tools and libraries from your project's virtualenv without you having to run poetry run / uv run

Poe can also be used as a general purpose task runner.

Contributing

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

Also check out the CONTRIBUTING guide 🤓

License

MIT

Project details


Release history Release notifications | RSS feed

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.36.0.tar.gz (66.9 kB view details)

Uploaded Source

Built Distribution

poethepoet-0.36.0-py3-none-any.whl (88.0 kB view details)

Uploaded Python 3

File details

Details for the file poethepoet-0.36.0.tar.gz.

File metadata

  • Download URL: poethepoet-0.36.0.tar.gz
  • Upload date:
  • Size: 66.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for poethepoet-0.36.0.tar.gz
Algorithm Hash digest
SHA256 2217b49cb4e4c64af0b42ff8c4814b17f02e107d38bc461542517348ede25663
MD5 5f523e82771abca55ee662c1e9c75dd7
BLAKE2b-256 cfac311c8a492dc887f0b7a54d0ec3324cb2f9538b7b78ea06e5f7ae1f167e52

See more details on using hashes here.

Provenance

The following attestation bundles were made for poethepoet-0.36.0.tar.gz:

Publisher: ci.yml on nat-n/poethepoet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file poethepoet-0.36.0-py3-none-any.whl.

File metadata

  • Download URL: poethepoet-0.36.0-py3-none-any.whl
  • Upload date:
  • Size: 88.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for poethepoet-0.36.0-py3-none-any.whl
Algorithm Hash digest
SHA256 693e3c1eae9f6731d3613c3c0c40f747d3c5c68a375beda42e590a63c5623308
MD5 6af1b3f2f265b4c6458b2f3f934c5168
BLAKE2b-256 0329dedb3a6b7e17ea723143b834a2da428a7d743c80d5cd4d22ed28b5e8c441

See more details on using hashes here.

Provenance

The following attestation bundles were made for poethepoet-0.36.0-py3-none-any.whl:

Publisher: ci.yml on nat-n/poethepoet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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