TASKPY(1)

📦 version 1.14.1, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 TASKPY(1) — the general commands manual moment 💖

okay bestie so this is taskipy, aka the taskipy automation tool for Python projects, and it lives in the General Commands Manual section of your terminal's heart 🎀 no cap, this one's a keeper.

✨ NAME ✨

taskipy — the Taskipy automation tool for Python projects 🦋

🌸 SYNOPSIS 🌸

task [-h] [--help] [--list] [name] [args]

💅 DESCRIPTION 💅

so, the Taskipy project? it's literally a utility for automating tasks in Python projects, and it gives you a super simple way to define and execute all your various development tasks. the way that it lets you define stuff like style checking (lint) or any other operations and then run them via a single configuration file?? iconic. main character energy fr fr. 👑

🫶 USAGE 🫶

wanna install Taskipy as a dev dependency? use Poetry, bestie:

poetry add --dev taskipy

and for Anaconda Python-based environments, Taskipy is also available via conda-forge 🌈:

conda install -c conda-forge taskipy

⭐ OPTIONS ⭐

  • -h, --help — shows the help message and then exits, like a polite little icon 💖
  • -l, --list — shows you a list of all the available tasks, so you can vibe check your options ✨

🍓 EXAMPLES 🍓

wanna see what tasks you've got? list 'em:

task -l

wanna run one specific task? bet:

task test

and here's the full rundown of the available tasks, no skipping, every single one 👇

  • test — runs all tests 🧚
  • post_test — runs linting after tests: ./task lint
  • test_windows — command used by Windows CI on Github
  • lint — lints project using pylint for style and mypy for typings
  • lint_pylint — runs pylint tests for Taskipy
  • lint_mypy — runs mypy tests for Taskipy
  • make_release_commit — creates a tagged commit for the release.
⚠️ do not use this directly, bestie. i'm serious. 🙈
  • pre_publish_patch — runs tests before publishing a patch version: ./task test
  • publish_patch — publishes a patch version that includes fixes but no new features (x.x.PATCH)
  • pre_publish_minor — runs tests before publishing a minor version: ./task test
  • publish_minor — publishes a minor version with new features (x.MINOR.x)

🔥 SEE ALSO 🔥

take a look at https://github.com/taskipy/taskipy?tab=readme-ov-file#readme for more info on how to use Taskipy 💜

👑 AUTHOR 👑

Taskipy was created by Josenilson Ferreira da Silva <nilsonfsilva@hotmail.com>. please visit https://github.com/taskipy/taskipy/issues for any issues related to Taskipy 🫶

and that's the whole page, bestie 💖 this was the Taskipy Manual, dated July 2024 — Taskipy Manual, July 2024, TASKPY(1), slay, periodt ✨💅🎀

📦 where this page comes from