From edf6f1d46ac32210f2a999550198f72740e9c3c3 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sun, 30 Apr 2023 13:05:15 -0400 Subject: Add basic usage example --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b62199..727afd9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Poetry Plugin for Taskipy +# Poetry plugin for taskipy This package is a plugin for the Poetry CLI that directly integrates [taskipy](https://github.com/taskipy/taskipy) into it. With this plugin installed, you may then use a `task` subcommand on the Poetry @@ -32,3 +32,36 @@ If you installed Poetry via Pip, you can install the plugin in that same environ ``` $ pip install poetry-plugin-taskipy ``` + +## Usage + +Once you've installed the taskipy poetry plugin, you'll now see a `task` subcommand on the base `poetry` CLI. + +``` +$ poetry +... + +Available commands: + ... + task Run a taskipy task. + ... +``` + + +If we assume the following basic `pyproject.toml` file in the current directory or a parent directory: + +```toml +[tool.poetry] +name = "project" +version = "0.1.0" + +[tool.taskipy.tasks] +test_echo = "echo 'test'" +``` + +We may then run: + +``` +$ poetry task test_echo +test +``` -- cgit v1.2.3