Skip to content

Latest commit

 

History

History
317 lines (214 loc) · 13.9 KB

README.md

File metadata and controls

317 lines (214 loc) · 13.9 KB

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

  • PayPal: paypal
  • BTC: bc1q3wxm269mdmwdqjqkxgt7s5zp8ah05dexdua0zv
  • ETH: 0x8c096710e3621fe5f8E384efBd17D8E3E798Dc0c (Cryptik.eth)
  • DOGE: D6n2g2KGdqEwR4MhhT7uAdvZFaTwqwd6rS
  • Venmo: @dtcarls

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/

  • Sends out the following messages on this schedule:
  • Close Scores - Mon - 18:30 east coast time (Games that are within 16 points of eachother to keep an eye on during the Monday night game)
  • Scoreboard - Mon,Tue,Fri - 7:30 local time (Current ESPN fantasy scoreboard)
  • Trophies - Tue - 7:30 local time (High score, low score, biggest win, closest win)
  • Power rankings - Tue - 18:30 local time
  • Current standings - Wed - 7:30 local time
  • Waiver report - Wed - 7:30 local time
  • Matchups - Thu - 19:30 east coast time (Upcoming matchups)
  • Players to Monitor report - Sun - 7:30 local time (Players in starting lineup that are Questionable, Doubtful, or Out)
  • Scoreboard - Sun - 16:00, 20:00 east coast time (Current ESPN fantasy scoreboard)

Table of Contents

😰😰😰

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.

😰😰😰

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"

Next we will setup the bot for GroupMe

Go to https://dev.groupme.com/session/new and login

Click "Create Bot"

Create your bot. GroupMe does a good job explaining what each thing is.

After you have created your bot you will see something similar to this. Click "Edit"

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

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.

Change the toggle from Off to On.

Select Add New Webhook to Workspace

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.

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

Go to Webhooks

Create a webhook, give it a name and pick which channel to receive messages in

Save the "Webhook URL" on this page

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

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

🚨Click this purple button to automatically deploy the code:🚨

Deploy

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

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.

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 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."

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:

git clone https://github.com/dtcarls/fantasy_football_chat_bot

cd fantasy_football_chat_bot

docker build -t fantasy_football_chat_bot .

Without Docker:

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. ⚠️ ESPN_S2 and SWID are required for this to work ⚠️
DAILY_WAIVER Bool No False If set to True, will provide a waiver report of add/drops daily. ⚠️ ESPN_S2 and SWID are required for this to work ⚠️
ESPN_S2 String For Private leagues None Used for private leagues. See Private Leagues Section for documentation
SWID String For Private leagues None Used for private leagues. (Can be defined with or without {}) See Private Leagues Section 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)

>>> 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)

>>> 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:

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]?

  • No, this would require a significant rework for other sites.

How do I set another timezone?

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

  • No, but I am open to pull requests implementing their API for additional cross platform support.

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

  • TOP_HALF_SCORING: If set to True, when standings are posted on Wednesday it will also include top half scoring wins
  • Top half wins is being in the top half of your league for points and you receive an additional "win" for it. The number in parenthesis (+1) tells you how many added wins over the season for top half wins.