sniffers 0.1.0

A simple file change sniffer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# sniffers
Basic file sniffer for detecting changes in files and directories, written in Rust; complete with python bindings (of course).

## Installation
```bash
pip install sniffers
```

## Usage
```python
from sniffers import Sniffer

sniffer = Sniffer()

# index a file or directory
sniffer.index()

# detect changes
changes = sniffer.sniff()

# print changes
for change in changes:
    print(change)
```

## Command Line Interface
There also exists a command line interface for this package.

To build and run the CLI, run the following commands:
```
cargo install --path .
```

Then, you can run the CLI as follows:

```bash
sniffers index
sniffers sniff
```