[](https://pypi.org/project/taskipy/) [](https://github.com/illBeRoy/taskipy/actions?query=workflow%3A%22Taskipy+Test+CI%22) [](#contributors-)
## General **> The complementary task runner for python. _** Every development pipeline has tasks, such as `test`, `lint` or `publish`. With taskipy, you can define those tasks in one file and run them with a simple command. For instance, instead of running the following command: ```bash python -m unittest tests/test_*.py ``` You can create a task called `test` and simply run: ```bash poetry run task test ``` Or (if you're not using poetry): ```bash task test ``` In addition, you can compose tasks and group them together, and also create dependencies between them. This project is heavily inspired by npm's [run script command](https://docs.npmjs.com/cli/run-script). ## Requirements Python 3.6 or newer. Your project directory should include a valid `pyproject.toml` file, as specified in [PEP-518](https://www.python.org/dev/peps/pep-0518/). ## Usage ### Installation To install taskipy as a dev dependency, simply run: ```bash poetry add --dev taskipy ``` ### Adding Tasks In your `pyproject.toml` file, add a new section called `[tool.taskipy.tasks]`. The section is a key-value map, from the names of the task to the actual command that should be run in the shell. There are two ways to define tasks. The easy way is to simply write the command down as a string: __pyproject.toml__ ```toml [tool.taskipy.tasks] test = "python -m unittest tests/test_*.py" lint = "pylint tests taskipy" ``` Alternatively, you can define tasks more explicitly by declaring both the command and a helpful description using an inline table: __pyproject.toml__ ```toml [tool.taskipy.tasks] test = { cmd = "python -m unittest tests/test_*.py", help = "runs all unit tests" } lint = { cmd = "pylint tests taskipy", help = "confirms code style using pylint" } ``` The explicit notation is more verbose, but provides better context to anyone who uses the task. ### Running Tasks In order to run a task, run the following command in your terminal: ```bash $ poetry run task test ``` You can also list all existing tasks by running the following: ```bash $ poetry run task --list test python -m unittest tests/test_*.py lint pylint tests taskipy ``` If you declared your task explicitly, you will see the description of the task by the side of the task's name: ```bash $ poetry run task --list test runs all unit tests lint confirms code style using pylint ``` ### Passing Command Line Args to Tasks If you want to pass command line arguments to tasks (positional or named), simply append them to the end of the task command. For example, running the above task like this: ```bash poetry run task test -h ``` Is equivalent to running: ```bash python -m unittest tests/test_*.py -h ``` And will show unittest's help instead of actually running it. > ⚠️ Note: if you are using pre \ post hooks, do notice that arguments are not passed to them, only to the task itself. ### Composing Tasks #### Grouping Subtasks Together Some tasks are composed of multiple subtasks. Instead of writing plain shell commands and stringing them together, you can break them down into multiple subtasks: ```toml [tool.taskipy.tasks] lint_pylint = "pylint tests taskipy" lint_mypy = "mypy tests taskipy" ``` And then create a composite task: ```toml [tool.taskipy.tasks] lint = "task lint_pylint && task lint_mypy" lint_pylint = "pylint tests taskipy" lint_mypy = "mypy tests taskipy" ``` #### Pre Task Hook Tasks might also depend on one another. For example, tests might require some binaries to be built. Take the two following commands, for instance: ```toml [tool.taskipy.tasks] test = "python -m unittest tests/test_*.py" build = "make ." ``` You could make tests depend on building, by using the **pretask hook**: ```toml [tool.taskipy.tasks] pre_test = "task build" test = "python -m unittest tests/test_*.py" build = "make ." ``` The pretask hook looks for `pre_Roy Sommer |
Eugene Triguba 💻 |
RobinFrcd 💻 |
Bernardas Ališauskas 💻 |