VTL Engine Documentation

The VTL Engine is a Python library that allows you to validate and run VTL scripts. It is a Python-based library around the VTL Language 2.1

The vtlengine library is compatible with pysdmx, which is a Python library to handle SDMX data and metadata. Check the pysdmx documentation for more information.

Useful links

• MeaningfulData: who we are

• Source Code

• PyPI link

• Bug Tracker

• New features Tracker

Installation

Requirements

The VTL Engine requires Python 3.9 or higher.

Install with pip

To install the VTL Engine on any Operating System, you can download it from pip:

pip install vtlengine

Important

It is recommended to install any python package in a virtual environment. Please follow these steps

S3 Extra

If you would like to use the S3 capabilities, you need to install the s3 extra:

pip install vtlengine[s3]

The S3 extra is based on the pandas[aws] extra, which requires to set up some environment variables. Please check the boto3 documentation

• 10 minutes to VTL Engine
  • Semantic Analysis
    • Example 1: Correct VTL
    • Example 2: Incorrect VTL
  • Run VTL Scripts
    • Example 3: Simple run
    • Example 4: Run from SDMX Dataset
  • Prettify
• API
  • generate_sdmx()
  • prettify()
  • run()
  • run_sdmx()
  • semantic_analysis()