Metadata-Version: 2.3
Name: pysentinel
Version: 0.1.0
Summary: A python pakcage for threshold based alerting using simple configuration.
License: MIT
Author: Rakibul Haq
Author-email: haq.rakibul@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown

# 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](https://python-poetry.org/) or `pip`.

### Using Poetry

```bash
poetry add pysentinel
```

### Using pip

```bash
pip install pysentinel
```

## Usage

```python
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:

```bash
poetry install
```

To run tests:

```bash
poetry run pytest
```

## License

MIT
