Giter Club home page Giter Club logo

matchy's Introduction

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

matchy's People

Contributors

chasec99 avatar ell-ml avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.