Skip to main content

Python CLI wrapper for VAST - Visibility Across Space and Time

Reason this release was yanked:

Switched to semantic versioning scheme

Project description

PyVAST - VAST Python CLI Wrapper

With pyvast we provide a very minimal python wrapper around the VAST command line interface. The wrapper features fluent method chaining and works asynchronously.

All VAST commands can be used with the wrapper. However, the wrapper does not implement any commands itself. It simply passes all received arguments to the vast binary. It is hence very easy to make mistakes in form of typos, given this minimalistic implementation. Please refer to the vast documentation for details about valid vast commands.


Commands are simply chained via .-notation. Parameters can be passed as python keyword arguments. The following examples provide an overview of VAST commands and the analogous pyvast commands.

  • Query for an IP address and return 10 results in JSON
    # CLI call
    vast export --max-event=10 json ':addr =='
    # python wrapper
    stdout, stderr = vast.export(max_events=10).json("").exec()
  • Import a Zeek log file
    # CLI call
    vast import zeek --read=/path/to/file
    # python wrapper
    stdout, stderr = vast.import_().zeek(read="/path/to/file").exec()

Full Example

The following example shows a minimalistic working example with all required import statements.

#!/usr/bin/env python3

import asyncio
from pyvast import VAST

vast = VAST(binary="/opt/tenzir/bin/vast")

stdout, stderr ="").exec())

See also the example folder for a demo using pyarrow for data export.


The tests are written with the python unittest library and its asynchronous analogon aiounittest. Install the requirements.txt first to run the tests.

pip install --user -r requirements.txt
python -m unittest discover .


Use the for installation or development setup.

virtualenv --system-site-packages venv # create a virtual env
source venv/bin/activate
python develop # or python install

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvast-2020.3.26.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

pyvast-2020.3.26-py3-none-any.whl (4.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page