Skip to main content

A python pakcage for threshold based alerting using simple configuration.

Project description

pysentinel

pysentinel is a Python package for threshold-based alerting using simple configuration. It scans data sources and raises alerts when specified thresholds are crossed.

Features

  • Scan data sources for threshold violations
  • Simple configuration for thresholds and alerts
  • Easy integration into existing Python projects

Installation

You can install pysentinel using Poetry or pip.

Using Poetry

poetry add pysentinel

Using pip

pip install pysentinel

Usage

from pysentinel import Sentinel

# Example configuration
config = {
    "data_source": "path/to/data.csv",
    "thresholds": {
        "column1": 100,
        "column2": 50
    }
}

sentinel = Sentinel(config)
alerts = sentinel.scan()

if alerts:
    for alert in alerts:
        print(f"Alert: {alert}")

Requirements

  • Python >= 3.9, < 4.0

Development

To set up the development environment:

poetry install

To run tests:

poetry run pytest

License

MIT

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

pysentinel-0.1.0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pysentinel-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file pysentinel-0.1.0.tar.gz.

File metadata

  • Download URL: pysentinel-0.1.0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for pysentinel-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b65f8bc91fe830ca44c2a29544799583b204c451fe8f196c14c28660c7b5e777
MD5 d69c4edb3a78cdaeeeeec0fe2ca1cffa
BLAKE2b-256 c1fa54de7f223403ef26517210c6d10b054902f8b4208fcd2e1e7c9953517062

See more details on using hashes here.

File details

Details for the file pysentinel-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pysentinel-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for pysentinel-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d5b434f81b27c3cde81535632a294b772a5224feb8fa5020affff5c8e0fc270
MD5 989cccf63bc6091d94810972c2854b17
BLAKE2b-256 6450b1a163d3d594b48d8923b40b86569b1be0da27473d85e3ba8c5b8bc5dbc8

See more details on using hashes here.

Supported by

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