Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.72 KB

INSTALL.md

File metadata and controls

20 lines (12 loc) · 1.72 KB
Raw

Installation

  1. Make sure you have a supported version of Python installed, and pip, Python's package manager.
  2. Decide what Python 'environment' you want to install vit into. Projects like Virtualenv and pyenv allow you to run non-system Python installations, and are the recommended way to safely install additional Python packages. You may also choose to install vit as a package in your system's Python installation.
  3. Once you've decided what environment to install to, simply run: pip install vit

Tab completion

Since VIT takes report/filter arguments when invoked (just like Taskwarrior), it can be helpful to leverage Taskwarrior's existing tab completion functionality when starting VIT.

scripts/bash/vit.bash_completion provides a wrapper to Taskwarrior's bash completion support.

Place that file somewhere that the bash completion software can load it, and restart your shell to use.

Older System Pythons

VIT is written in Python, and tracks the Python code lifecycle. As such, unsupported versions of Python may not run on VIT, and will not be supported by the maintainers. You can view a list of currently supported Python versions here.

However, even if your machine's system Python is no longer supported, you can still run VIT easily by installing a supported version of Python alongside the system Python. There are several projects such as Virtualenv and pyenv that make this quite easy.