VAST Python
The Python package of VAST provides a flexible control plane to integrate VAST with other security tools.
Note The Python effort is still highly experimental and subject to rapid change. Please do not consider it for production use.
Usage
To get started, clone the VAST repository and install the Python package via Poetry:
git clone https://github.com/tenzir/vast.git
cd vast/python
poetry install
Development
We recommend that you work with an editable installation, which is the default
for poetry install.
Unit Tests
Run the unit tests via pytest:
poetry run pytest
Integration Tests
Run the integrations tests via Docker Compose and pytest:
./docker-poetry-run.sh pytest -v
Packaging
The following instructions concern maintainers who want to publish the Python package to PyPI.
Note Our releasing scripts and CI run these steps automatically. You do not need to intervene anywhere. The instructions below merely document the steps taken.
Bump the version
Prior to releasing a new version, bump the version, e.g.:
poetry version 2.3.1
This updates the pyproject.toml file.
Publish to Test PyPI
-
Add a Test PyPi repository:
poetry config repositories.test-pypi https://test.pypi.org/legacy/
-
Get the token from https://test.pypi.org/manage/account/token/.
-
Store the token:
poetry config pypi-token.test-pypi pypi-XXXXXXXX
-
Publish:
poetry publish --build -r test-pypi
Publish to PyPI
-
Get the token from https://pypi.org/manage/account/token/.
-
Store the token:
poetry config pypi-token.pypi pypi-XXXXXXXX
-
Publish
poetry publish --build
Metadata
Release files for pyvast 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyvast-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / pyvast-3.1.0-py3-none-any.whl
| Download URL | pyvast-3.1.0-py3-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c8fbe34e71879e350588a74877fb313ec4f5950d3f2765f58f2378f032fce9a
|
|
BLAKE2b-256 checksum How to use checksums |
24f27a3fb2850aac52c53e99c3c29e72112e32d7497e0da6f82ff9464d82a8fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.0 CPython/3.10.11 Linux/5.15.0-1037-azure
|
Security for pyvast 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.