Installation

Stream2Vault (S2V) is distributed as a Python package. You can install it using your preferred Python packaging tool. We recommend using uv for its speed and efficiency, but pip is also fully supported.

Before proceeding, ensure you have Python 3.12+ and a packaging tool installed.

tip

It's highly recommended to install S2V within a Python virtual environment to avoid conflicts with other projects or system-wide packages.

Installation Methods

Using uv (Recommended)

If you have uv installed, you can install S2V directly. uv can also manage virtual environments seamlessly.

1. Create and activate a virtual environment (optional but recommended):

uv venv
source .venv/bin/activate # Or .\.venv\Scripts\activate on Windows

2. Install Stream2Vault:

uv pip install s2v-client

Using pip

You can use pip, the standard Python package installer.

1. Create and activate a virtual environment (optional but recommended):

   python -m venv s2v_env 
   source s2v_env/bin/activate # Or .\s2v_env\Scripts\activate on Windows
2. Install Stream2Vault:

   pip install s2v-client

Verifying the Installation

After installation, you can verify that S2V is installed correctly by checking its version:

s2v version

This should output the installed version of Stream2Vault.

Upgrading S2V

To upgrade S2V to the latest version:

Using uv

uv pip install --upgrade s2v-client

Using pip

pip install --upgrade s2v-client