blob: 4fb455a404e6f2a118273d7901ddc1f135c6ddce (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# 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
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.
### With Poetry installed via the official installer
With the official installer, you can use the Poetry CLI itself to install the plugin.
```
$ poetry self add poetry-plugin-taskipy
```
### With Poetry installed via Pipx
If you installed Poetry via Pipx, you'll want to utilize the `inject` command.
```
$ pipx inject poetry poetry-plugin-taskipy
```
### With Poetry installed via Pip
If you installed Poetry via Pip, you can install the plugin in that same environment.
```
$ 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
```
For more information, see the [taskipy documentation](https://github.com/taskipy/taskipy/blob/master/README.md).
|