README.md

Slack Data Collector

Branch	Build Status
master

Synopsis

Uses the Slack API to collect anonymized information about the community

Installation & Configuration

Minimum Requirements

- Python 2.7 or 3.5
- pip or pip3

1. Clone the repository into any directory you have access to:

   git clone https://github.com/mena-devs/slack_data_collector

2. Copy the example configuration file, rename it config.yml and modify it to your liking:

   cp config/config.example.yml config/config.yml

3. Install the package:

   python setup.py install

4. Run the tests

   tox

5. Run the script

   python slackcollector/collector.py

Unit Testing

slack_data_collector uses tox to run unit tests inside virtualenvs. If you want to run them you simply need to install tox and run it:

pip install tox
tox

By default this script tests against python 2.7 and python 3.5. If you want to test versus a specific version, you can always specify it on the CLI:

# to test against python 3.3
tox -e py33

Sample Output

{
    "cache_ts": 1466800744,
    "members": [
        {
            "presence": "away",
            "deleted": true,
            "id": "U04B7LSFG",
            "is_bot": true,
            "team_id": "T03B400RJ"
        },
        {
            "presence": "away",
            "is_ultra_restricted": false,
            "deleted": false,
            "is_owner": false,
            "tz_label": null,
            "is_admin": false,
            "is_restricted": false,
            "is_primary_owner": false,
            "id": "U0AE305C4",
            "tz": "EET",
            "color": "50a0cf",
            "tz_offset": 10800,
            "has_2fa": false,
            "team_id": "T03B400RJ",
            "is_bot": false,
            "status": null
        },
        {
            "presence": "away",
            "is_ultra_restricted": false,
            "deleted": false,
            "is_owner": false,
            "tz_label": null,
            "is_admin": false,
            "is_restricted": false,
            "is_primary_owner": false,
            "id": "U03B5176N",
            "tz": "EET",
            "color": "e7392d",
            "tz_offset": 10800,
            "has_2fa": false,
            "team_id": "T03B400RJ",
            "is_bot": false,
            "status": null
        },
        {
            "presence": "away",
            "is_ultra_restricted": false,
            "deleted": false,
            "is_owner": false,
            "tz_label": null,
            "is_admin": false,
            "is_restricted": false,
            "is_primary_owner": false,
            "id": "U03CWMQSH",
            "tz": "EET",
            "color": "db3150",
            "tz_offset": 10800,
            "has_2fa": false,
            "team_id": "T03B400RJ",
            "is_bot": false,
            "status": null
        }
        ...
    ],
    "ok": true
}

Contributing

We would very much appreciate any and all contributions for this project. Nevertheless, in order for us to manage this repository efficiently, please review and abide by the contribution guidelines detailed in this document: CONTRIBUTING.md before pushing your changes.