<commit_before># Pysellus - A monitor and alerting system for your data

<img src="https://dl.dropboxusercontent.com/u/29178650/logo.png" alt="Pysellus logo" align="right"/>

[![Build Status](https://travis-ci.org/Pysellus/pysellus.svg)](https://travis-ci.org/Pysellus/pysellus)
[![Coverage Status](https://coveralls.io/repos/Pysellus/pysellus/badge.svg?branch=master&service=github)](https://coveralls.io/github/Pysellus/pysellus?branch=master)

---

Pysellus is a stream-based, monitoring and alerting service that runs automatic tests against your data.

### What would I use this for?

- Filtering, merging and cleaning your data.
- Searching for schemas and information in large, real-time data streams.
- Setting up automatic alerts, notifications and triggers that run whenever a match happens.

### Requirements

Pysellus is written in [Python 3](https://www.python.org/downloads/release/python-343/), so you will need to have it installed.

Additionally, if you want to install Pysellus with `pip`, you will need to have `pip3` installed.

### Installation

You can get Pysellus just by running:

```
$ pip3 install pysellus
```

Or you can go ahead and clone this repo, and install it

```
$ python3 setup.py install
```

### Getting started

Pysellus works by running some user-defined tests against all elements in a data stream.

Let's get started by writing a very basic test:

```python
input = stream([0, 1, 2, 3])
<commit_msg>Update install instructions<commit_after># Pysellus - A monitor and alerting system for your data

<img src="https://dl.dropboxusercontent.com/u/29178650/logo.png" alt="Pysellus logo" align="right"/>

[![Build Status](https://travis-ci.org/Pysellus/pysellus.svg)](https://travis-ci.org/Pysellus/pysellus)
[![Coverage Status](https://coveralls.io/repos/Pysellus/pysellus/badge.svg?branch=master&service=github)](https://coveralls.io/github/Pysellus/pysellus?branch=master)

---

Pysellus is a stream-based, monitoring and alerting service that runs automatic tests against your data.

### What would I use this for?

- Filtering, merging and cleaning your data.
- Searching for schemas and information in large, real-time data streams.
- Setting up automatic alerts, notifications and triggers that run whenever a match happens.

### Requirements

Pysellus is written in [Python 3](https://www.python.org/downloads/release/python-343/), so you will need to have it installed.

Additionally, if you want to install Pysellus with `pip`, you will need to have `pip3` installed.

### Installation

You can get Pysellus just by running:

```
$ pip3 install pysellus
```

Or you can go ahead and clone this repo, and install it (needs [setuptools](https://pypi.python.org/pypi/setuptools))

```
$ python3 setup.py install
```

### Getting started

Pysellus works by running some user-defined tests against all elements in a data stream.

Let's get started by writing a very basic test:

```python
input = stream([0, 1, 2, 3])

{'fraction_non_alphanumeric': 0.11580013504388927, 'fraction_numerical': 0.012829169480081027, 'mean_word_length': 4.709055876685935, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 13, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2664383', 'n_tokens_mistral': 983, 'n_tokens_neox': 925, 'n_words': 318}