Install Vectice Python library

Setup your environment to work with Vectice.

Vectice offers a Python API library that allows data scientists to log project milestones directly from their preferred notebook or IDE.

Before installing Vectice, let's ensure you have the necessary dependencies. You will need the following:

1. Python 3.8 version or greater.

2. To have pip installed.

Python 3.7 is no longer maintained by the community. Upgrade to Python 3.8 or higher to ensure full compatibility with Vectice and access to its complete features.

Open a terminal, command line, or notebook and run the following command:

pip install vectice

The line above installs the latest version of Vectice published in PyPI.

To install a specific version that is compatible with your server, specify the version number like this: pip install vectice==version number. You can find all the Vectice versions here.

To ensure you have successfully installed the Vectice Python client library, run the following command:

pip show vectice

You should see an output that shows the name, version, and more information about the library, similar to the image below.

🎉 Great! You have now installed the Vectice Python client library! Let's move on to configuring your work environment and connecting to the Vectice API.

Extras

The Vectice Python API may require additional installations for some functionalities. For example, to utilize AWS S3 for data storage, you would require pip install vectice["s3"].

You can chain multiple installations by using the following notation.

pip install vectice["s3, gcs"]

The supported options are the following:

Extras	Installation Notation	Description
AWS S3	pip install vectice["s3"]	Enables you to use S3DataWrapper
Google Cloud Storage	pip install vectice["gcs"]	Enables you to use the GcsDataWrapper