slackrs 0.2.0

Provides a CLI and library functions to analyze Slack message data exports (zipped JSONs with a Slack-specific structure) and plot statistics.
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# slackrs

A simple CLI to analyze Slack data exports.

[![Crate](https://img.shields.io/crates/v/slackrs.svg)](https://crates.io/crates/slackrs)
[![Docs](https://docs.rs/slackrs/badge.svg)](https://docs.rs/slackrs)
[![Rust](https://github.com/roland-ewald/slackrs/actions/workflows/rust.yml/badge.svg)](https://github.com/roland-ewald/slackrs/actions/workflows/rust.yml)

## Features

- Plot **number of messages** containing a specific string over time (**histogram**).

- Plot **ratio of messages** containing either one of two specific strings (**line chart**).

- **Export CSV files** with the statistics and allow to aggregate over **different time scales** (daily, monthly, yearly).

- **Simple customization** regarding plot colors.

## Sample usage

### Retrieving the data from Slack

Bulk downloads of (public) messages are available per workspace, but require admin access.

In the 'Slack app', do the following (alternatively, just go to `https://[your-workspace].slack.com/services/export` in the browser):

1. Use the dropdown of the workspace, choose `Tools & Settings` > `Admin Tools`.
2. In the `Admin Tools` go to `Data Exports`.

Then choose an export range and trigger the export.

### Sample task file

The tool processes all messages from the ZIP and then runs a number of tasks, which are defined in JSON:

```json
[
    {
        "metric": {
            "MentionCount": {
                "channel_pattern": "",
                "message_pattern": "@group"
            }
        },
        "resolution": "Daily",
        "output_file_name": "daily-group-mentions-over-time.png"
    }
]    
```

### Running the tool

```shell
./slackrs --input-file="my-slack-export.zip" --task-file=my_tasks.json
```

### Sample output

Plots look like this right now:

![Sample histogram output visualizing message counts per day](doc/img/sample-output.png)

Additionally, all plotted data is also provided as a CSV.

### More documentation

To see all command-line arguments, just run:

```shell
./slackrs --help
```