Installation

Installation#

vcztools is available on PyPI:

python3 -m pip install vcztools

This will install the vcztools program into your local Python path.

Alternatively, calling:

python3 -m vcztools <args>

is equivalent to:

vcztools <args>

and will always work.

Reading from some remote storage backends requires extra packages. The obstore and icechunk backends are install extras:

python3 -m pip install vcztools[obstore]
python3 -m pip install vcztools[icechunk]

The fsspec backend ships with the default install, but the driver for each cloud protocol is a separate package which must be installed separately:

python3 -m pip install s3fs    # S3
python3 -m pip install gcsfs   # Google Cloud Storage
python3 -m pip install adlfs   # Azure

See the Storage backends section for which backend and package to use for a given store.

To enable shell completion for a particular session in Bash do:

eval "$(_VCZTOOLS_COMPLETE=bash_source vcztools)"

If you add this to your .bashrc shell completion should be available in all new shell sessions.

See the Click documentation for instructions on how to enable completion in other shells.