From def73b770e18b40b59ee2f709c18c442641c873c Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Thu, 19 Mar 2026 22:44:28 -0400 Subject: Setup poetry-plugin-taskipy2 fork from original plugin --- README.md | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4fb455a..2721ccd 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ -# Poetry plugin for taskipy +# Poetry plugin for taskipy2 -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 -CLI to run your regular taskipy tasks. +> poetry-plugin-taskipy2 is a continuation fork of [poetry-plugin-taskipy](https://github.com/taskipy/poetry-plugin-taskipy). + +This package is a plugin for the Poetry CLI that directly integrates +[taskipy2](https://git.sr.ht/~eugenetriguba/taskipy2) into it. With this plugin +installed, you may then use a `task` subcommand on the Poetry CLI to run your +regular taskipy tasks. ## Installation -There are multiple ways to install this plugin and the way you should install it depends on -how you've installed Poetry itself. +There are multiple ways to install this plugin and the way you should install it +depends on how you've installed Poetry itself. ### With Poetry installed via the official installer -With the official installer, you can use the Poetry CLI itself to install the plugin. +With the official installer, you can use the Poetry CLI itself to install the +plugin. ``` -$ poetry self add poetry-plugin-taskipy +$ poetry self add poetry-plugin-taskipy2 ``` ### With Poetry installed via Pipx @@ -22,20 +26,22 @@ $ poetry self add poetry-plugin-taskipy If you installed Poetry via Pipx, you'll want to utilize the `inject` command. ``` -$ pipx inject poetry poetry-plugin-taskipy +$ pipx inject poetry poetry-plugin-taskipy2 ``` ### With Poetry installed via Pip -If you installed Poetry via Pip, you can install the plugin in that same environment. +If you installed Poetry via Pip, you can install the plugin in that same +environment. ``` -$ pip install poetry-plugin-taskipy +$ pip install poetry-plugin-taskipy2 ``` ## Usage -Once you've installed the taskipy poetry plugin, you'll now see a `task` subcommand on the base `poetry` CLI. +Once you've installed the taskipy poetry plugin, you'll now see a `task` +subcommand on the base `poetry` CLI. ``` $ poetry @@ -48,7 +54,8 @@ Available commands: ``` -If we assume the following basic `pyproject.toml` file in the current directory or a parent directory: +If we assume the following basic `pyproject.toml` file in the current directory +or a parent directory: ```toml [tool.poetry] @@ -66,4 +73,4 @@ $ poetry task test_echo test ``` -For more information, see the [taskipy documentation](https://github.com/taskipy/taskipy/blob/master/README.md). \ No newline at end of file +For more information, see the [taskipy2 documentation](https://git.sr.ht/~eugenetriguba/taskipy2). -- cgit v1.2.3