# 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/taskipy/poetry-plugin-taskipy",
"name": "poetry-plugin-taskipy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "tasks,task runner,development,poetry,plugin",
"author": "Taskipy Team",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/14/7c/940caf8f3cce39b166fbae015a96b80a44665358e505e3b18f382b71e845/poetry_plugin_taskipy-1.0.0.tar.gz",
"platform": null,
"description": "# Poetry plugin for taskipy\n\nThis package is a plugin for the Poetry CLI that directly integrates [taskipy](https://github.com/taskipy/taskipy)\ninto it. With this plugin installed, you may then use a `task` subcommand on the Poetry\nCLI to run your regular taskipy tasks.\n\n## Installation\n\nThere are multiple ways to install this plugin and the way you should install it depends on\nhow you've installed Poetry itself.\n\n### With Poetry installed via the official installer\n\nWith the official installer, you can use the Poetry CLI itself to install the plugin.\n\n```\n$ poetry self add poetry-plugin-taskipy\n```\n\n### With Poetry installed via Pipx\n\nIf you installed Poetry via Pipx, you'll want to utilize the `inject` command.\n\n```\n$ pipx inject poetry poetry-plugin-taskipy\n```\n\n### With Poetry installed via Pip\n\nIf you installed Poetry via Pip, you can install the plugin in that same environment.\n\n```\n$ pip install poetry-plugin-taskipy\n```\n\n## Usage\n\nOnce you've installed the taskipy poetry plugin, you'll now see a `task` subcommand on the base `poetry` CLI.\n\n```\n$ poetry\n...\n\nAvailable commands:\n ...\n task Run a taskipy task.\n ...\n```\n\n\nIf we assume the following basic `pyproject.toml` file in the current directory or a parent directory:\n\n```toml\n[tool.poetry]\nname = \"project\"\nversion = \"0.1.0\"\n\n[tool.taskipy.tasks]\ntest_echo = \"echo 'test'\"\n```\n\nWe may then run:\n\n```\n$ poetry task test_echo\ntest\n```\n\nFor more information, see the [taskipy documentation](https://github.com/taskipy/taskipy/blob/master/README.md).",
"bugtrack_url": null,
"license": "MIT",
"summary": "Poetry plugin for taskipy",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/taskipy/poetry-plugin-taskipy",
"Repository": "https://github.com/taskipy/poetry-plugin-taskipy"
},
"split_keywords": [
"tasks",
"task runner",
"development",
"poetry",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69aa03a0b2e926266950dc492c620ad4487467e8c4c92c0941e6bcc783ca77ff",
"md5": "37cc277801de2f0cdc5e8dbc512ad549",
"sha256": "4ee94574ed1164747405829db4f48d7ad395d707c85adb7cca64310eae2d5221"
},
"downloads": -1,
"filename": "poetry_plugin_taskipy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37cc277801de2f0cdc5e8dbc512ad549",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 3965,
"upload_time": "2023-05-26T12:02:26",
"upload_time_iso_8601": "2023-05-26T12:02:26.095085Z",
"url": "https://files.pythonhosted.org/packages/69/aa/03a0b2e926266950dc492c620ad4487467e8c4c92c0941e6bcc783ca77ff/poetry_plugin_taskipy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "147c940caf8f3cce39b166fbae015a96b80a44665358e505e3b18f382b71e845",
"md5": "d3ed07fb4776c3654a001c16ece9629a",
"sha256": "80e1552c9be7729d7c36f78fb97fd76464d210468ef0edd1c7ef408332fa7987"
},
"downloads": -1,
"filename": "poetry_plugin_taskipy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d3ed07fb4776c3654a001c16ece9629a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 3518,
"upload_time": "2023-05-26T12:02:27",
"upload_time_iso_8601": "2023-05-26T12:02:27.470437Z",
"url": "https://files.pythonhosted.org/packages/14/7c/940caf8f3cce39b166fbae015a96b80a44665358e505e3b18f382b71e845/poetry_plugin_taskipy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 12:02:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "taskipy",
"github_project": "poetry-plugin-taskipy",
"github_not_found": true,
"lcname": "poetry-plugin-taskipy"
}
JSON
