aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2026-03-19 21:41:53 -0400
committerEugene Triguba <hello@eugenetriguba.com>2026-03-19 21:49:09 -0400
commit0ef63ae5ebe60cfc05f091ed843bf706a5422be3 (patch)
treebfc26a1d99164cce8ebfafd0183cf464222b3788
parentRemove .vscode directory (diff)
downloadtaskipy2-0ef63ae5ebe60cfc05f091ed843bf706a5422be3.zip
Document both uv and poetry usage in README
-rw-r--r--README.md67
1 files changed, 36 insertions, 31 deletions
diff --git a/README.md b/README.md
index 0d651d0..e6d84d8 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
**The complementary task runner for python.**
+> taskipy2 is a continuation fork of [taskipy](https://github.com/taskipy/taskipy).
+
- [Overview](#overview)
- [Requirements](#requirements)
- [Usage](#usage)
@@ -26,8 +28,6 @@
## Overview
-> taskipy2 is a continuation fork of [taskipy](https://github.com/taskipy/taskipy).
-
[![pypi](https://img.shields.io/pypi/v/taskipy2?style=flat-square)](https://pypi.org/project/taskipy2/)
[![pypi-downloads](https://img.shields.io/pypi/dm/taskipy2?style=flat-square)](https://pypi.org/project/taskipy2/)
@@ -42,16 +42,18 @@ For instance, instead of running the following command:
python -m unittest tests/test_*.py
```
-You can create a task called `test` and simply run:
+You can create a task called `test` and simply run (in your virtual environment):
```bash
-poetry run task test
+task test
```
-Or (if you're not using poetry):
+If you're using a tool like [poetry](https://python-poetry.org/) or [uv](https://docs.astral.sh/uv/), you could run:
```bash
-task test
+poetry run task test
+# or
+uv run task test
```
In addition, you can compose tasks and group them together, and also create
@@ -70,7 +72,34 @@ specified in [PEP-518](https://www.python.org/dev/peps/pep-0518/).
### Installation
-To install taskipy as a dev dependency, simply run:
+To install taskipy via pip, run:
+
+```bash
+pip install taskipy2
+```
+
+#### Poetry
+
+```bash
+poetry add --group dev taskipy2
+```
+
+#### uv
+
+```bash
+uv add --dev taskipy
+```
+
+#### Running Tasks
+
+Head into your project's directory (don't forget to activate virtualenv if
+you're using one), and run the following command:
+
+```bash
+task TASK
+```
+
+Where `TASK` is the name of your task.
```bash
poetry add --group dev taskipy2
@@ -334,30 +363,6 @@ same working directory) you just need to declare that under taskipy's
cwd = "."
```
-### Using Taskipy Without Poetry
-
-Taskipy was created with poetry projects in mind, but actually only requires
-a valid `pyproject.toml` file in your project's directory. As a result, you can
-use it even without poetry:
-
-#### Installing With PIP
-
-Install taskipy on your machine or in your virtualenv using:
-
-```bash
-pip install taskipy2
-```
-
-#### Running Tasks
-
-Head into your project's directory (don't forget to activate virtualenv if
-you're using one), and run the following command:
-
-```bash
-task TASK
-```
-
-Where `TASK` is the name of your task.
### Advanced Use Cases