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

Uploaded Source

Built Distribution

poethepoet-0.35.0-py3-none-any.whl (87.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for poethepoet-0.35.0.tar.gz
Algorithm Hash digest
SHA256 b396ae862d7626e680bbd0985b423acf71634ce93a32d8b5f38340f44f5fbc3e
MD5 1b951b5072d4685ef7504cbefc549762
BLAKE2b-256 d6b1d4f4361b278fae10f6074675385ce3acf53c647f8e6eeba22c652f8ba985

See more details on using hashes here.

Provenance

The following attestation bundles were made for poethepoet-0.35.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.35.0-py3-none-any.whl.

File metadata

  • Download URL: poethepoet-0.35.0-py3-none-any.whl
  • Upload date:
  • Size: 87.2 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.35.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bed5ae1fd63f179dfa67aabb93fa253d79695c69667c927d8b24ff378799ea75
MD5 bacaa2c318ba2f75c3f0aaf5398085e3
BLAKE2b-256 3808abc2d7e2400dd8906e3208f9b88ac610f097d7ee0c7a1fa4a157b49a9e86

See more details on using hashes here.

Provenance

The following attestation bundles were made for poethepoet-0.35.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