New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

poethepoet

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

poethepoet

A task runner that works well with poetry.

0.33.0
PyPI
Maintainers
1

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 📖


Features

  • ✅ Straight forward declaration of project tasks in your pyproject.toml (or poe_tasks.toml)

  • ✅ Tasks are run in poetry's virtualenv (or another env you specify)

  • Shell completion of task names (and global options too for zsh)

  • ✅ The poe CLI can be used standalone, or as a plugin for poetry

  • ✅ Tasks can be commands, shell scripts, python expressions, or references to python functions

  • ✅ Concise commands with extra arguments passed to the task poe [options] task [task_args]

  • ✅ Easily define CLI arguments for your tasks

  • ✅ Tasks can specify and reference environment variables, even without a shell

  • ✅ Tasks are self documenting, with optional help messages (just run poe with no arguments)

  • ✅ Tasks can be composed into sequences or DAGs

  • ✅ Works with .env files

  • ✅ Can be used as a library to embed in other tools

  • ✅ Also works fine without poetry

Quick start

pipx install poethepoet
  • 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
  • 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.

Contributing

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

Also check out the CONTRIBUTING guide 🤓

License

MIT

Keywords

automation

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts