<commit_before># Redmon
Monitor a Redis key

## Installation
Redmon requires a working Redis connection.

To install Redmon from pip,
```
  pip install redmon
```

Or from source,
```
  python setup.py install
```

## Setup
Redmon connects to your Redis connection with the following environment variables.
If none are set, default values are used.
- REDMON_REDIS_HOST (default, `localhost`) : Set it to where your Redis is running from.
- REDMON_REDIS_PORT (default, `6379`)      : Set it to where your Redis is running on.
- REDMON_TIME_INT (default, `1.0`)           : Set refresh interval for your Redis key

## Get Started
To watch a Redis key, just simply

```
  redmon monitor --key=sample
```

Redmon now watches a key called `sample` every second.

### Setting Refresh Intervals

Changing the refresh interval for your monitor is very simple. You can either set it with
an environment variable or by passing it as an argument.

```
REDMON_TIME_INT=2 redmon monitor --key=sample
```

```
redmon monitor --key=snapshot --interval=2
```

Redmon now watches a key called `sample` every two seconds.

**Intervals passed as arguments take precedence.**

```
REDMON_TIME_INT=2 redmon monitor --key=snapshot --interval=3
```

Redmon now watches a key called `sample` every three seconds.

## Running Tests
Redmon uses `pytest` to write/run test cases. To run the test cases,

```
  cd tests
  py.test
```

## Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repo
2. [Clone] (https://help.github.com/articles/cloning-a-repository/) your newly forked repo
3. Write relevant test cases
4. Raise pull requests to [swaathi/redmon](https://github.com/swaathi/redmon)

## Coming Up
- Monitor multiple keys
- Set the values your Redis key should be compared against
- Set the values your Redis key should never be
<commit_msg>Updating Readme.md<commit_after># Redmon
Monitor a Redis key

## Installation
Redmon requires a working Redis connection.

To install Redmon from pip,
```
  pip install redmon
```

Or from source,
```
  python setup.py install
```

## Setup
Redmon connects to your Redis connection with the following environment variables.
If none are set, default values are used.
- REDMON_REDIS_HOST (default, `localhost`) : Set it to where your Redis is running from.
- REDMON_REDIS_PORT (default, `6379`)      : Set it to where your Redis is running on.
- REDMON_TIME_INT (default, `1.0`)           : Set refresh interval for your Redis key

## Get Started
To watch a Redis key, just simply

```
  redmon monitor --key=sample
```

Redmon now watches a key called `sample` every second.

### Setting Refresh Intervals

Changing the refresh interval for your monitor is very simple. You can either set it with
an environment variable or by passing it as an argument.

```
REDMON_TIME_INT=2 redmon monitor --key=sample
```

```
redmon monitor --key=sample --interval=2
```

Redmon now watches a key called `sample` every two seconds.

**Intervals passed as arguments take precedence.**

```
REDMON_TIME_INT=2 redmon monitor --key=sample --interval=3
```

Redmon now watches a key called `sample` every three seconds.

## Running Tests
Redmon uses `pytest` to write/run test cases. To run the test cases,

```
  cd tests
  py.test
```

## Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repo
2. [Clone] (https://help.github.com/articles/cloning-a-repository/) your newly forked repo
3. Write relevant test cases
4. Raise pull requests to [swaathi/redmon](https://github.com/swaathi/redmon)

## Coming Up
- Monitor multiple keys
- Set the values your Redis key should be compared against
- Set the values your Redis key should never be

{'fraction_non_alphanumeric': 0.09834733134651856, 'fraction_numerical': 0.007586020048767272, 'mean_word_length': 3.969044414535666, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '846006', 'n_tokens_mistral': 1148, 'n_tokens_neox': 1097, 'n_words': 469}