dtcarls / fantasy_football_chat_bot

GroupMe Discord and Slack Chatbot for ESPN Fantasy Football
GNU General Public License v3.0
297 stars 234 forks source link
chat-bot chatbot discord discord-bot discordapp discordbot espn espn-fantasy-football fantasy-football groupme groupme-bot groupme-chat python slack slack-bot slack-webhook slackbot

GitHub release Test workflow Publish workflow

For troubleshooting and release notifications, join the discord!

Discord Banner 2

Like the bot? Star the repository and consider making a donation to buy me a coffee

ESPN Fantasy Football GroupMe Slack and Discord Chat Bot

This repository runs a GroupMe, Discord, or Slack chat bot to send ESPN Fantasy Football information to a GroupMe, Discord or Slack chat room.

What does this do?

Schedule Link: https://www.gamedaybot.com/message-schedule/

Table of Contents

:cold_sweat::cold_sweat::cold_sweat:

All of this look too complicated and confusing? Don't know what a "Heroku" is? Consider checking out https://www.GameDayBot.com/ where I offer a hosting service and do my best to minimize complexity.

:cold_sweat::cold_sweat::cold_sweat:

Setting up GroupMe, Discord, or Slack, and deploying app in Heroku

Do not deploy 2 of the same bot in the same chat. In general, you should let your commissioner do the setup

GroupMe Setup

Click to expand! Go to www.groupme.com and sign up or login If you don't have one for your league already, create a new "Group Chat" ![](https://i.imgur.com/32ioDoZ.png) Next we will setup the bot for GroupMe Go to https://dev.groupme.com/session/new and login Click "Create Bot" ![](https://i.imgur.com/TI1bpwE.png) Create your bot. GroupMe does a good job explaining what each thing is. ![](https://i.imgur.com/DQUcuuI.png) After you have created your bot you will see something similar to this. Click "Edit" ![](https://i.imgur.com/Z9vwKKt.png) This page is important as you will need the "Bot ID" on this page.You can also send a test message with the text box to be sure it is connected to your chat room. Side note: If you use the bot id depicted in the page you will spam an empty chat room so not worth the effort ![](https://i.imgur.com/k65EZFJ.png)

Slack setup

Click to expand! Go to https://slack.com/signin and sign in to the workspace the bot will be in If you don't have one for your league already, create a new League Channel Next we will setup the bot for Slack Go to https://api.slack.com/apps/new Name the app, and choose the intended workspace from the dropdown. Select the Incoming Webhooks section on the side. ![](https://i.imgur.com/ziRQCVP.png) Change the toggle from Off to On. Select Add New Webhook to Workspace ![](https://i.imgur.com/tJRRrfz.png) In the Post to dropdown, select the channel you want to send messages to, then select Authorize. This page is important as you will need the "Webhook URL" on this page. ![](https://i.imgur.com/mmzhDS0.png)

Discord setup

Click to expand! Log into or create a discord account Go to or create a discord server to receive messages in Open the server settings ![](https://i.imgur.com/bDk2ttJ.png) Go to Webhooks ![](https://i.imgur.com/mfFHGbT.png) Create a webhook, give it a name and pick which channel to receive messages in ![](https://i.imgur.com/NAJLv6D.png) Save the "Webhook URL" on this page ![](https://i.imgur.com/U4MKZSY.png)

Heroku setup

"November 28, 2022, Heroku stopped offering free product plans"

I offer a hosting service far lower than the new costs of Heroku at https://www.GameDayBot.com/

Click to expand! Heroku is what you can use to host the chat bot. Go to https://id.heroku.com/login and sign up or login :warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning: :rotating_light:**Click this purple button to automatically deploy the code:**:rotating_light: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) :warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning: Go to your dashboard (https://dashboard.heroku.com/apps) Now you will need to setup your environment variables so that it works for your league. Click Settings at your dashboard. Then click "Reveal Config Vars" button and you will see something like this. ![](https://i.imgur.com/7a1V6v8.png) Now we will need to edit these variables (click the pencil to the right of the variable to modify) Note: App will restart when you change any variable so your chat room may be semi-spammed with the init message of "Hi" you can change the INIT_MSG variable to be blank to have no init message. It should also be noted that Heroku seems to restart the app about once a day See [Environment Variables Section](#environment-variables) for documentation After you have setup your variables you will need to turn it on. Navigate to the "Resources" tab of your Heroku app Dashboard. You should see something like below. Click the pencil on the right and toggle the buton so it is blue like depicted and click "Confirm." ![](https://i.imgur.com/J6bpV2I.png) You're done! You now have a fully featured GroupMe/Slack/Discord chat bot for ESPN leagues! If you have an INIT_MSG you will see it exclaimed in your GroupMe, Discord, or Slack chat room. Unfortunately to do auto deploys of the latest version you need admin access to the repository on git. You can check for updates on the github page (https://github.com/dtcarls/fantasy_football_chat_bot/commits/master) and click the deploy button again; however, this will deploy a new instance and the variables will need to be edited again.

Getting Started for development and testing

Click to expand! These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. ### Installing for development With Docker: ```bash git clone https://github.com/dtcarls/fantasy_football_chat_bot cd fantasy_football_chat_bot docker build -t fantasy_football_chat_bot . ``` Without Docker: ```bash git clone https://github.com/dtcarls/fantasy_football_chat_bot cd fantasy_football_chat_bot pip install -r requirements.txt # or #python3 setup.py install ``` ### Environment Variables |Var|Type|Required|Default|Description| |---|----|--------|-------|-----------| |BOT_ID|String|For GroupMe|None|This is your Bot ID from the GroupMe developers page| |SLACK_WEBHOOK_URL|String|For Slack|None|This is your Webhook URL from the Slack App page| |DISCORD_WEBHOOK_URL|String|For Discord|None|This is your Webhook URL from the Discord Settings page| |LEAGUE_ID|String|Yes|None|This is your ESPN league id| |START_DATE|Date|Yes|Start of current season (YYYY-MM-DD)|This is when the bot will start paying attention and sending messages to your chat.| |END_DATE|Date|Yes|End of current season (YYYY-MM-DD)|This is when the bot will stop paying attention and stop sending messages to your chat.| |LEAGUE_YEAR|String|Yes|Currernt Year (YYYY)|ESPN League year to look at| |TIMEZONE|String|Yes|America/New_York|The timezone that the messages will look to send in.| |INIT_MSG|String|No|None|The message that the bot will say when it is started.| |TOP_HALF_SCORING|Bool|No|False|If set to True, when standings are posted on Wednesday it will also include being in the top half of your league for points and you receive an additional "win" for it.| |RANDOM_PHRASE|Bool|No|False|If set to True, when matchups are posted on Tuesday it will also include a random phrase| |MONITOR_REPORT|Bool|No|False|If set to True, will provide a report of players in starting lineup that are Questionable, Doubtful, Out, or projected for less than 4 points| |WAIVER_REPORT|Bool|No|False|If set to True, will provide a waiver report of add/drops. :warning: ESPN_S2 and SWID are required for this to work :warning:| |DAILY_WAIVER|Bool|No|False|If set to True, will provide a waiver report of add/drops daily. :warning: ESPN_S2 and SWID are required for this to work :warning:| |ESPN_S2|String|For Private leagues|None|Used for private leagues. See [Private Leagues Section](#private-leagues) for documentation| |SWID|String|For Private leagues|None|Used for private leagues. (Can be defined with or without {}) See [Private Leagues Section](#private-leagues) for documentation| ### Running with Docker Use BOT_ID if using Groupme, DISCORD_WEBHOOK_URL if using Discord, and SLACK_WEBHOOK_URL if using Slack (or multiple to get messages in multiple places) ```bash >>> export BOT_ID=[enter your GroupMe Bot ID] >>> export WEBHOOK_URL=[enter your Webhook URL] >>> export LEAGUE_ID=[enter ESPN league ID] >>> export LEAGUE_YEAR=[enter league year] >>> cd fantasy_football_chat_bot >>> docker run --rm=True \ -e BOT_ID=$BOT_ID \ -e LEAGUE_ID=$LEAGUE_ID \ -e LEAGUE_YEAR=$LEAGUE_YEAR \ fantasy_football_chat_bot ``` ### Running without Docker Use BOT_ID if using Groupme, DISCORD_WEBHOOK_URL if using Discord, and SLACK_WEBHOOK_URL if using Slack (or multiple to get messages in multiple places) ```bash >>> export BOT_ID=[enter your GroupMe Bot ID] >>> export WEBHOOK_URL=[enter your Webhook URL] >>> export LEAGUE_ID=[enter ESPN league ID] >>> export LEAGUE_YEAR=[enter league year] >>> python3 gamedaybot/espn/espn_bot.py ``` ### Running the tests Automated tests for this package are included in the `tests` directory. After installation, you can run these tests by changing the directory to the `gamedaybot` directory and running the following: ```python3 pip install -r requirements-test.txt pytest ```

Private Leagues

For private league you will need to get your swid and espn_s2. You can find these two values after logging into your espn fantasy football account on espn's website. (Chrome Browser) Right click anywhere on the website and click inspect option. From there click Application on the top bar. On the left under Storage section click Cookies then http://fantasy.espn.com. From there you should be able to find your swid and espn_s2 variables and values.

FAQ

League must be full.

The bot isn't working

How are power ranks calculated?

Is there a version of this for Yahoo/CBS/NFL/[insert other site]?

How do I set another timezone?

Is there a version of this for Messenger/WhatsApp/[insert other chat]?

My Standings look wrong. I have weird (+1) in it.