Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 2.13 KB

README.md

File metadata and controls

43 lines (35 loc) · 2.13 KB
Raw

Matchy

A Slack Bot that pairs people in a given channel to meet up for a one-on-one.

Example Message

Introduction

Coronavirus has taken away the social norms of creating friends in-person. Nowadays, it's difficult to meet new people, form bonds, and foster community. This is especially true for large organizations whose members can no longer meet face to face. With Matchy in your Slack workspace, freely spread your wings and start forming new connections while building a sense of community within your org!

MatchyLogo

Features

On command, this Slack Bot:

  • Introduces each user in a channel to a fellow, randomized, member on the team.
  • Instigates one-on-one virtual meetings for its paired users.
  • Keeps track of previously paired users to more evenly distribute the pairings.

Dependencies

Slack : pip install slackclient

Running Matchy

To get Matchy running in your Slack Workspace, follow the steps below:

  • Create a new Slack App install it in your Slack Workspace
    • Update the Display Information to add the Matchy name and logo
    • Add the necessary Bot Token Scopes
      • channels:read
      • chat:write
      • mpim:write
    • Install into your workspace and retrieve the Bot User OAuth Access Token!
  • Install the project dependencies $ pip3 install -r requirements.txt
  • Create a file in your matchy/ directory called config.py by renaming config.sample.py. It should contain the following lines:
OAUTH_TOKEN = ''    # Bot User OAuth Access Token from Slack.
CHANNEL     = ''    # ID of your channel. You can find this by right clicking on the channel, selecting "Copy Link", and taking the ID at the end of the URL.
IGNORE_LIST = {}    # Any user IDs that you would like to ignore when generating pairs.
  • Finally, run Matchy to pair people in the channel. You will need to run Matchy each time you want new pairings to go out:
    • python matchy.py

Previous partners will be stored to the file called partners.json.

Contributors