Setup

• Python 3.10 or higher.
• Access to a terminal or command prompt.
• Git, for cloning the repository.
• A code editor (e.g., Visual Studio Code) is recommended.

If you haven't already, clone the OPVS Samples repository:

git clone https://github.com/opvsproject/opvs-samples.git -b main --depth 1
cd opvs-samples

We recommend using a virtual environment for Python projects. The OPVS Python SDK uses `uv` for dependency management, but you can use `pip` with `venv` as well.

**Create and activate a virtual environment:**

Using `venv` (standard library):

python -m venv .venv
source .venv/bin/activate

**Install needed Python dependencies along with the OPVS SDK and its dependencies:**

pip install -r samples/python/requirements.txt

After installation, you should be able to import the `opvs` package in a Python interpreter:

python -c "import opvs; print('OPVS SDK imported successfully')"

If this command runs without error and prints the success message, your environment is set up correctly.