Skip to main content

A security telemetry engine for detection and response

Project description

Tenzir Python

The Python package of Tenzir provides a flexible control plane to integrate Tenzir 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 Tenzir repository and install the Python package via Poetry:

git clone https://github.com/tenzir/tenzir.git
cd tenzir/python
poetry install -E module

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

  1. Add a Test PyPi repository:

    poetry config repositories.test-pypi https://test.pypi.org/legacy/
    
  2. Get the token from https://test.pypi.org/manage/account/token/.

  3. Store the token:

poetry config pypi-token.test-pypi pypi-XXXXXXXX
  1. Publish:

    poetry publish --build -r test-pypi
    

Publish to PyPI

  1. Get the token from https://pypi.org/manage/account/token/.

  2. Store the token:

poetry config pypi-token.pypi pypi-XXXXXXXX
  1. Publish

    poetry publish --build
    

Project details


Download files

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

Source Distribution

tenzir-4.19.4.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

tenzir-4.19.4-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file tenzir-4.19.4.tar.gz.

File metadata

  • Download URL: tenzir-4.19.4.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.19 Linux/5.15.0-1068-azure

File hashes

Hashes for tenzir-4.19.4.tar.gz
Algorithm Hash digest
SHA256 082ed15c01265b81eb812b5c0fa2301d882f111e6a730d7d071756b754e474a2
MD5 819937c7ab930eb8c01ea481e65a067f
BLAKE2b-256 11814e8f964d51a882f29d2c3e3a0c86ccfde6e70480e8dc82b7198dec624ac6

See more details on using hashes here.

File details

Details for the file tenzir-4.19.4-py3-none-any.whl.

File metadata

  • Download URL: tenzir-4.19.4-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.19 Linux/5.15.0-1068-azure

File hashes

Hashes for tenzir-4.19.4-py3-none-any.whl
Algorithm Hash digest
SHA256 16d737644bf86e93f1ab0318437236249df02a8b6a56882cbdd80ef26232e7ed
MD5 cdf1eb4ff2585772c0b707d1bb15b25d
BLAKE2b-256 010876ed7b587e36e776b4f3301536ebd7c0ad778bee6fecf5b641210b2b67e9

See more details on using hashes here.

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