Getting Started

Requirements

Python 3.9+

Optional Packages:

pandas

• pandas is needed if you want to convert a QVD data table to a pandas DataFrame and vice versa. It is not a required dependency. See pandas for more information.

It is generally recommended to use python virtual environment or conda virtual environment.

Installation

PyQvd is a Python library available through pypi. The recommended way to install and maintain PyQvd as a dependency is through the package installer (PIP). Before installing this library, download and install Python.

To use PyQvd, first install it using pip:

(.venv) $ pip install PyQvd

Usage

To use PyQvd in a project, import the module and create a QvdTable object. The QvdTable class is the primary interface for working with QVD files in PyQvd. It represents the parsed data table from a QVD file and provides methods and properties to work with the data. A QvdTable can be constructed in different ways, depending on the source of the data. The most common way is to load a QVD file from disk:

from pyqvd import QvdTable

tbl = QvdTable.from_qvd("path/to/file.qvd")
print(tbl.head())

The above example loads the PyQvd library and parses an example QVD file. A QVD file is typically loaded using the QvdTable.from_qvd function of the QvdTable class. For more ways to load/construct QvdTable’s see API Reference. After loading the file’s content, numerous methods and properties are available to work with the parsed data.