Installation¶

Requirements¶

Python 3.11 or higher
No external dependencies (uses only Python standard library)

Install from PyPI¶

pip install taskfile-help

Install from Source¶

Clone the repository and install:

git clone https://github.com/royw/taskfile-help.git
cd taskfile-help
pip install .

Development Installation¶

For development, install with dev dependencies:

Using uv¶

git clone https://github.com/royw/taskfile-help.git
cd taskfile-help
uv sync --dev  # creates .venv/ and installs dependencies
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

Or using pip¶

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Verify Installation¶

Check that the installation was successful:

taskfile-help --help

You should see the help message with all available options.

Alternative Invocation Methods¶

You can invoke taskfile-help in several ways:

Console Script (Recommended)¶

taskfile-help

Python Module¶

python -m taskfile_help

Direct Python Import¶

from taskfile_help.taskfile_help import main
import sys

sys.exit(main())

Upgrading¶

To upgrade to the latest version:

pip install --upgrade taskfile-help

Uninstalling¶

To remove taskfile-help:

pip uninstall taskfile-help