Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uberfastman/fantasy-football-metrics-weekly-report
Command line application to create weekly reports (containing stats, metrics, and rankings) for Fantasy Football leagues on the following platforms: Yahoo, Fleaflicker, Sleeper, ESPN.
https://github.com/uberfastman/fantasy-football-metrics-weekly-report
cbs cbs-fantasy-api cbs-fantasy-football espn espn-fantasy-api espn-fantasy-football fantasy-football fantasy-football-api fleaflicker fleaflicker-fantasy-api fleaflicker-fantasy-football google-drive-api hacktoberfest slack-api sleeper sleeper-fantasy-api sleeper-fantasy-football yahoo yahoo-fantasy-api yahoo-fantasy-football
Last synced: 21 days ago
JSON representation
Command line application to create weekly reports (containing stats, metrics, and rankings) for Fantasy Football leagues on the following platforms: Yahoo, Fleaflicker, Sleeper, ESPN.
- Host: GitHub
- URL: https://github.com/uberfastman/fantasy-football-metrics-weekly-report
- Owner: uberfastman
- License: gpl-3.0
- Created: 2016-08-29T03:22:47.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T14:42:10.000Z (about 2 months ago)
- Last Synced: 2024-09-13T02:58:27.777Z (about 2 months ago)
- Topics: cbs, cbs-fantasy-api, cbs-fantasy-football, espn, espn-fantasy-api, espn-fantasy-football, fantasy-football, fantasy-football-api, fleaflicker, fleaflicker-fantasy-api, fleaflicker-fantasy-football, google-drive-api, hacktoberfest, slack-api, sleeper, sleeper-fantasy-api, sleeper-fantasy-football, yahoo, yahoo-fantasy-api, yahoo-fantasy-football
- Language: Python
- Homepage:
- Size: 6.53 MB
- Stars: 192
- Watchers: 20
- Forks: 46
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - uberfastman/fantasy-football-metrics-weekly-report - Command line application to create weekly reports (containing stats, metrics, and rankings) for Fantasy Football leagues on the following platforms: Yahoo, ESPN, CBS, Sleeper, Fleaflicker (Python)
README
# Fantasy Football Metrics Weekly Report [](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/stargazers) [](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/network/members)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/actions/workflows/python-build.yml)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/blob/main/LICENSE)
---
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/releases/latest)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/releases/latest)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/tags)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/commits/main)
---
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/issues)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/pulls)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestones)
➡️
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestone/3)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestone/2)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestone/4)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestone/5)
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestones?state=closed)
➡️
[](https://github.com/uberfastman/fantasy-football-metrics-weekly-report/milestone/1)
---
#### Fantasy Football Platform Support: [Yahoo](#yahoo-setup), [ESPN](#espn-setup), [Sleeper](#sleeper-setup), [Fleaflicker](#fleaflicker-setup), [CBS](#cbs-setup)
***You can see an example of what a report looks like [here](resources/files/example_report.pdf)!***
---
###### Do you like the app? Star the repository here on GitHub and please consider donating to help support its development!
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VZZCNLRHH9BQS)
[
](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VZZCNLRHH9BQS)
---
###### Interested in contributing to the project? [](resources/documentation/README.md)
---
### Table of Contents
* ***[Quickstart Guide](#quickstart-guide)***
* [About](#about)
* [Example Report](#example-report)
* [Updating](#updating)
* [Dependencies](#dependencies)
* [Setup](#setup)
* [Command-line](#command-line)
* [Git](#git)
* [Docker](#docker)
* [GitHub](#github)
* [Platforms](#platforms)
* [Yahoo Setup](#yahoo-setup)
* [Fleaflicker Setup](#fleaflicker-setup)
* [Sleeper Setup](#sleeper-setup)
* [ESPN Setup](#espn-setup)
* [CBS Setup](#cbs-setup)
* [Running the Report Application](#running-the-report-application)
* [Settings](#settings)
* [Report Features](#report-features)
* [Report Formatting](#report-formatting)
* [Report Settings](#report-settings)
* [Usage](#usage)
* [Additional Integrations](#additional-integrations)
* [Google Drive](#google-drive-setup)
* [Slack](#slack-setup)
* [GroupMe](#groupme-setup)
* [Discord](#discord-setup)
* [Troubleshooting](#troubleshooting)
* [Logs](#logs)
* [Yahoo](#yahoo)
* [ESPN](#espn)
* [Docker on Windows](#docker-on-windows)
* [Reportlab](#reportlab)
---
1. Open a command-line interface (see the [Command-line](#command-line) section for more details) on your computer.
* ***macOS***: type `Cmd + Space` (`⌘ + Space`) to bring up Spotlight, and search for "Terminal" and hit enter).
* ***Windows***: type `Windows + R` to open the "Run" box, then type `cmd` and then click "OK" to open a regular Command Prompt (or type `cmd` and then press `Ctrl + Shift + Enter` to open a Command Prompt as administrator.)
* ***Linux (Ubuntu)***: type `Ctrl+Alt+T`.
2. Install Git (see [Git](#git) section for more details).
* ***macOS***: run `git --version` for the first time, and when prompted, install the *Xcode Command Line Tools*.
* ***Windows***: Download [Git for Windows](https://git-scm.com/download/win) and install it.
* ***Linux (Ubuntu)***: `sudo apt install git-all` (see above link for different Linux distributions)
3. Install [Docker Desktop](#docker) for your operating system.
* ***macOS***: [Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
* ***Windows***: [Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/)
* ***Linux***: [Docker for Linux](https://docs.docker.com/engine/install/)
4. Clone this app from GitHub (see [GitHub](#github) section for more details) to wherever you would like to store the app code on your computer (I recommend something like your user Documents folder).
```bash
git clone https://github.com/uberfastman/fantasy-football-metrics-weekly-report.git
```
5. Navigate into the cloned app directory within the command line by running:
```bash
cd fantasy-football-metrics-weekly-report
```
6. Follow the required setup instructions for whichever fantasy football platform you use: [Yahoo](#yahoo-setup), [ESPN](#espn-setup), [Sleeper](#sleeper-setup), [Fleaflicker](#fleaflicker-setup), or [CBS](#cbs-setup).
7. Update the values in the `.env` file (see the [Settings](#settings) section for more details).
* *Alternately, the first time you try running the app it will detect that you have no `.env` file, and will ask you if you wish to create one. Provide values for the remaining prompts (it will ask you for your* **fantasy football platform**, *your* **league ID**, *the* **NFL season (year)**, *and the* **current NFL week**, *so have those values ready.*
8. Run the Fantasy Football Metrics Weekly Report app using Docker (see the [Running the Report Application](#running-the-report-application) section for more details). If on Windows, see the [Docker on Windows](#docker-on-windows) troubleshooting section if you encounter any permissions or access issues.
* Run:
```bash
docker compose up -d
```
If you wish to see the Docker logs, then run `docker compose up` without the `-d` flag.
* Wait for the above command to complete, then run:
```bash
docker exec -it fantasy-football-metrics-weekly-report-app-1 python main.py
```
* ***Follow the prompts to generate a report for your fantasy league!***
---
The Fantasy Football Metrics Weekly Report application automatically generates a report in the form of a PDF file that contains a host of metrics and rankings for teams in a given fantasy football league.
Currently supported fantasy football platforms:
* **Yahoo**
* **Fleaflicker**
* **Sleeper**
* **ESPN**
* **CBS**
***You can see an example of what a report looks like [here](resources/files/example_report.pdf)!***
Every time you run the app it will check to see if you are using the latest version (as long as you have an active network connection). If it detects that your app is out of date, you will see prompt asking you if you wish to update the app. Type `y` and hit enter to confirm.
If you wish to update the app yourself manually, you can just type `n` to skip automatically updating, and run `git pull origin main` manually from within the application directory on the command line.
If you wish to disable the automatic check for updates, you can set `CHECK_FOR_UPDATES=False` in your `.env` file and the app will skip checking GitHub for any updates. *Please note that until you set the `CHECK_FOR_UPDATES` environment variable back to its default value of `True`, the app will **never** attempt to check for updates again.*
---
The application is actively developed in macOS, but is cross-platform compatible. The app requires ***Python 3.10 or later***. To check if you have the minimum required version (or later) of Python installed, open up a window in Terminal (macOS), Command Prompt (Windows), or a command line shell of your choice, and run `python --version`. If the return value is `Python 3.x.x` where the first `x` is equal to or greater than the minimum required minor version, you are good to go. If the return is `Python 2.x.x`, you will need to install the correct Python 3 version. Check out the instructions [here](https://realpython.com/installing-python/) for how to install Python 3 on your system.
Project dependencies can be viewed in the [`requirements.txt`](requirements.txt) file.
---
The Fantasy Football Metrics Weekly Report requires several sets of setup steps, depending on which platform(s) for which you will be running it. To get the application running locally, you will first need to complete the below setup.
_\* General setup **excludes** Google Drive and Slack integrations. See [Additional Integrations](#additional-integrations) for details on including those add-ons._
---
Open a command-line terminal/prompt:
* ***macOS***: type `Cmd + Space` (`⌘ + Space`) to bring up Spotlight, and search for "Terminal" and hit enter).
* ***Windows***: type `Windows + R` to open the "Run" box, then type `cmd` and then click "OK" to open a regular Command Prompt (or type `cmd` and then press `Ctrl + Shift + Enter` to open a Command Prompt as administrator.)
* ***Linux (Ubuntu)***: type `Ctrl+Alt+T`.
Install `git` (if you do not already have it installed). You can see detailed instructions for installation on your OS [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
* ***macOS***: run `git --version` for the first time, and when prompted, install the *Xcode Command Line Tools*.
* ***Windows***: Download [Git for Windows](https://git-scm.com/download/win) and install it.
* ***Linux (Ubuntu)***: `sudo apt install git-all` (see above link for different Linux distributions)
**NOTE**: If you are comfortable using the command line, feel free to just install `git` for the command line. *However*, if using the command line is not something you have much experience with and would prefer to do less in a command line shell, you can install [Git for Desktop](https://desktop.github.com).
***If you use the Git for Desktop client, please keep the project name the same *** (`fantasy-football-metrics-weekly-report`) ***or else you will run into additional issues when running the app!***
* **NOTE: This application requires you to have administrative (admin) access for the computer on which you are installing it.**
Install [Docker](https://docs.docker.com/get-docker/) for your operating system:
* ***macOS***: [Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
* ***Windows***: [Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/)
* ***Linux***: [Docker for Linux](https://docs.docker.com/engine/install/)
Clone this project to whichever directory you wish to use for this app:
* If you do ***not*** have an existing account on GitHub and do ***not*** wish to create one, then use HTTPS by running:
```bash
git clone https://github.com/uberfastman/fantasy-football-metrics-weekly-report.git
```
* If you already have an account on [GitHub](https://github.com), then it is recommended you use [SSH to connect with GitHub](https://help.github.com/en/articles/connecting-to-github-with-ssh) by running:
```bash
git clone [email protected]:uberfastman/fantasy-football-metrics-weekly-report.git
```
---
Yahoo Fantasy Sports has a public API documented [here](https://developer.yahoo.com/fantasysports/guide/). The Fantasy Football Metrics Weekly Report application uses my own [YFPY](https://yfpy.uberfastman.com) Python wrapper around this API to retrieve the necessary data to generate reports.
1. Log in to a Yahoo account with access to whatever fantasy football leagues from which you wish to retrieve data.
2. Retrieve your Yahoo Fantasy football league id, which you can find by going to [https://football.fantasysports.yahoo.com](https://football.fantasysports.yahoo.com), clicking on your league, and looking here:
3. Change the `LEAGUE_ID` value in your `.env` file to the above located league id.
4. Go to [https://developer.yahoo.com/apps/create/](https://developer.yahoo.com/apps/create/) and create an app (you must be logged into your Yahoo account as stated above). For the app, fill out the following options:
1. `Application Name` (**Required**): `yahoo fantasy sports metrics` (you **must** fill out this field, but you can name your app whatever you want).
2. `Description` (*Optional*): you *may* write a description of what the app does.
3. `Home Page URL` (*Optional*): if you have a web address related to your app you *may* add it here.
4. `Redirect URI(s)` (**Required**): `localhost:8080` (you **must** fill out this field, but you can use whatever value you want as long as it is a valid redirect address).
5. `OAuth Client Type` (**Required**): this radio button should be automatically set to `Confidential Client`, so leave it as is (or set it to `Confidential Client` if it is not selected).
6. `API Permissions` (**Required**): you **must** check the `Fantasy Sports` checkbox and leave the `Read` option selected (appears in an accordion expansion underneath the `Fantasy Sports` checkbox once you select it).
5. Click the `Create App` button.
6. Once the app is created, it should redirect you to a page for your app, which will show both a `Client ID` and a `Client Secret`.
7. Open your `.env` file with your preferred text editor (such as TexEdit in macOS or Notepad in Windows), then copy and paste the above values into their respective environment variables (`YAHOO_CONSUMER_KEY` and `YAHOO_CONSUMER_SECRET`) as explained in [Settings](#settings).
8. The first time you run the app, it will initialize the OAuth connection between the report generator and your Yahoo account.
**NOTE**:***If your Yahoo league uses FAAB (Free Agent Acquisition Budget) for player waivers, you must set the `YAHOO_INITIAL_FAAB_BUDGET` value in the `.env` file to reflect your league's starting budget, since this information does not seem to be available in the Yahoo API.***
##### You are now ready to [generate a report!](#running-the-report-application)
---
Fleaflicker has a public API documented [here](https://www.fleaflicker.com/api-docs/index.html). The Fantasy Football Metrics Weekly Report application uses this API to retrieve the necessary data to generate reports. ***Please note, some data required to provide certain information to the report is not currently available in the Fleaflicker API, so for the time being web-scraping is used to supplement the data gathered from the Fleaflicker API.***
1. Retrieve your Fleaflicker league ID. You can find it by looking at the URL of your league in your browser:
2. Change the `LEAGUE_ID` value in the `.env` file to the above located league id.
3. Make sure that you have accurately set the value of `SEASON` in the `.env` file to reflect the desired year/season for which you are running the report application. This will ensure that the location of locally saved data is correct and API requests are properly formed.
4. You can also specify the year/season from the command line by running the report with the `-y ` flag.
5. Fleaflicker does not require any authentication to access their API at this time, so no additional steps are necessary.
##### You are now ready to [generate a report!](#running-the-report-application)
---
Sleeper has a public API documented [here](https://docs.sleeper.app). The Fantasy Football Metrics Weekly Report application uses this API to retrieve the necessary data to generate reports. ***Please note, some data required to provide certain information to the report is not currently available in the Sleeper API, so a few small things are excluded in the report until such a time as the data becomes available***. That being said, the missing data does not fundamentally limit the capability of the app to generate a complete report.
1. Retrieve your Sleeper league ID. You can find it by looking at the URL of your league in your browser:
2. Change the `LEAGUE_ID` value in the `.env` file to the above located league id.
3. *(Optional)* It is advised that you accurately set the `CURRENT_NFL_WEEK` value in the `.env` file to reflect the current/ongoing NFL week at the time of running the report, as the report will default to this value if retrieving the current NFL week from the Sleeper API (which the app uses to fetch the current NFL week) is unsuccessful.
##### You are now ready to [generate a report!](#running-the-report-application)
---
ESPN has an undocumented public API which changed from v2 to v3 in 2018 and introduced some variance to its functionality, and as such is subject to unexpected and sudden changes. The Fantasy Football Metrics Weekly Report application uses this API to retrieve the necessary data to generate reports. ***Please note, some data required to provide certain information to the report is not currently available in the ESPN API, so a few small things are excluded in the report until such a time as the data becomes available***. That being said, the missing data does not fundamentally limit the capability of the app to generate a complete report.
1. Retrieve your ESPN league ID. You can find it by looking at the URL of your league in your browser:
2. Change the `LEAGUE_ID` value in the `.env` file to the above located league id.
3. Make sure that you have accurately set the `SEASON` value in the `.env` file to reflect the desired year/season for which you are running the report application. This will ensure that the location of locally saved data is correct and API requests are properly formed.
4. You can also specify the year/season from the command line by running the report with the `-y ` flag.
5. Public ESPN leagues **do not** require any authentication to access their API at this time, so no additional steps are necessary for those leagues. However, certain data will not be available if you are not authenticated, so it is advised for you to still follow the below authentication steps anyway. For private leagues, you ***must*** complete one of the following authentication processes.
1. Allow the app to automatically retrieve your ESPN session cookies for you:
1. The first time you run the app for your private ESPN league, it will prompt you for the values of the below environment variable, and then automatically save them to your `.env` file:
1. `ESPN_USERNAME`: This environment variable is your ESPN account username.
2. `ESPN_PASSWORD`: This environment variable is your ESPN account password.
3. `ESPN_CHROME_USER_PROFILE_PATH`: This environment variable is the value of the `Profile Path` field in your Google Chrome version info, which can be retrieved by opening Google Chrome and navigating to [chrome://version](chrome://version), where you will see the `Profile Path` field.
***Please note, the FFMWR app only stores your credentials locally on your own computer so that it can use them to log in to your account and obtain session cookies.*** The app uses [Selenium](https://www.selenium.dev) to run a headless browser to log in to ESPN on your behalf, so expect to see an email alerting you to a new device login. The Selenium process will retrieve your ESPN session cookies (`SWID` and `espn_s2`) and copy them into your `.env` file for reuse with future ESPN API authentication.
**If you run into any issues during this automated credentials retrieval process, please check the [ESPN troubleshooting section](#espn).**
2. Manually retrieve your ESPN session cookies:
1. Steven Morse has done a great deal of fantastic work to help teach people how to use the ESPN fantasy API, and has a useful blog post [here](https://stmorse.github.io/journal/espn-fantasy-3-python.html) detailing how to get your own session cookies. As stated in the aforementioned blog, you can get the cookies following the subsequent steps.
2. *"A lot of the ESPN Fantasy tools are behind a login-wall. Since accounts are free, this is not a huge deal, but becomes slightly annoying for GET requests because now we somehow need to “login” through the request. One way to do this is to send session cookies along with the request. Again this can take us into a gray area, but to my knowledge there is nothing prohibited about using your own cookies for personal use within your own league."*
*Specifically, our GET request from the previous post is modified to look like, for example:*
```shell
r = requests.get(
'https://games.espn.com/ffl/api/v2/scoreboard',
params={'leagueId': 123456, 'seasonId': 2023, 'matchupPeriodId': 1},
cookies={'swid': '{SWID-COOKIE-HERE}', 'espn_s2': 'LONG_ESPN_S2_COOKIE_HERE'}
)
```
*This should return the info you want even for a private league. I saw that the SWID and the ESPN_S2 cookies were the magic tickets based on the similar coding endeavors here and here and here.*
*You can find these cookies in Safari by opening the Storage tab of Developer tools (you can turn on developer tools in preferences), and looking under espn.com in the Cookies folder. In Chrome, you can go to Preferences -> Advanced -> Content Settings -> Cookies -> See all cookies and site data, and looking for ESPN.*
3. Depending on what web browser (Firefox, Chrome, Edge, Brave, etc.) you are using, the process for viewing your session cookies in the web inspector will be different. I recommend Googling *"how to inspect element in [browser]"* (for your specific browser) to learn how to use that browser's web inspector.
4. Open your `.env` file with your preferred text editor (such as TexEdit in macOS or Notepad in Windows), then copy and paste the above cookies into their respective environment variables (`ESPN_COOKIE_SWID` and `ESPN_COOKIE_ESPN_S2`). ***Please note, the `swid` will be surrounded by curly braces (`{...}`), which must be included.***
**NOTE**: *Because ESPN made the change to their API between 2018 and 2019, ESPN support in the Fantasy Football Metrics Weekly Report application is currently limited to the 2019 season and later. Support for historical seasons will (hopefully) be implemented at a later time.
##### You are now ready to [generate a report!](#running-the-report-application)
---
CBS has a public API that was once documented, the last version of which can be viewed using the Wayback machine [here](https://web.archive.org/web/20150906150045/http://developer.cbssports.com/documentation). The Fantasy Football Metrics Weekly Report application uses this API to retrieve the necessary data to generate reports. ***Please note, some data required to provide certain information to the report is not currently available in the CBS API, so a few small things are excluded in the report until such a time as the data becomes available***. That being said, the missing data does not fundamentally limit the capability of the app to generate a complete report.
1. Retrieve your CBS league ID. You can find it by looking at the URL of your league in your browser:
2. Change the `LEAGUE_ID` value in the `.env` file to the above located league id.
3. The CBS API requires authentication to retrieve your league data, so you will need to use your CBS credentials to do so. The first time you run the app for your CBS league, it will prompt you for the values of your CBS account username and password, and then automatically save them to their respective environment variables (`CBS_USERNAME` and `CBS_PASSWORD`) in your `.env` file.
***Please note, the FFMWR app only stores your credentials locally on your own computer so it can use them to log in to your account and obtain an API access token.***
4. The first time you run the app, it will retrieve an API access token using your credentials and save it to your `.env` file. All subsequent runs of the report will simply use this access token to authenticate with the CBS API instead of your CBS credentials, so if you prefer you can delete your CBS username and CBS password from your `.env` file.
##### You are now ready to [generate a report!](#running-the-report-application)
---
### Running the Report Application
1. Make sure you have updated the default league ID (`LEAGUE_ID` in the `.env` file) to your own league id. Please see the respective setup instructions for your chosen platform for directions on how to find your league ID.
2. From within the application directory (you should already be inside the `fantasy-football-metrics-weekly-report` directory) , run:
```bash
docker compose up -d
```
1. *FIRST TIME RUNNING*: The first time you run the above command, you must wait for the Docker image to be pulled from the [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry). You will see output containing progress bars as the image layers are downloaded.
**NOTE**: If you are running *Docker for Windows* and you see errors when trying to build the Docker container and/or run `docker compose up -d`, please go to the [Docker on Windows](#docker-on-windows) section in [Troubleshooting](#troubleshooting) for workarounds!
2. *ALL RUNS*: After the initial run of the Docker container, you will not see all the image pull output as you did the first time. However, for all runs you will know when the app is ready when you see the below output:
```bash
fantasy-football-metrics-weekly-report-app-1 | Fantasy Football Metrics Weekly Report app is ready!
```
3. The docker image is now running and ready for use!
3. Run the report:
```bash
docker exec -it fantasy-football-metrics-weekly-report-app-1 python main.py
```
1. You should see the following prompts:
1. `Generate report for default league? (y/n) -> `.
Type `y` and hit enter.
2. `Generate report for default week? (y/n) ->`.
Type `y` and hit enter.
3. **NOTE FOR YAHOO USERS ONLY**: The ***FIRST*** time you run the app, you will see an `AUTHORIZATION URL` (if you followed the instructions in the [Yahoo Setup](#yahoo-setup) section).
1. Click the link (or copy and paste it into your web browser).
2. The browser window should display a message asking for access to Yahoo Fantasy Sports on your account. Click `Accept`.
3. You should then see a verifier code (something like `w6nwjvz`). Copy the verifier code and return to the command line window, where you should now see the following prompt:
```bash
Enter verifier :
```
Paste the verifier code there and hit enter.
4. Assuming the above went as expected, the application should now generate a report for your Yahoo fantasy league for the selected NFL week.
4. When you are *done* using the report app, it is recommended that you *shut down* the Docker container in which it is running. You can do so by running:
```bash
docker compose down
```
The next time you run the app, you can simply re-run `docker compose up -d` to restart the container.
***NOTE***: You can also specify a large number of settings directly in the command line. Please see the [usage section](#usage) for more information.
---
The Fantasy Football Metrics Weekly Report application allows certain aspects of the generated report to be set using a `.env` file, which defines a set of environment variables the app reads when it runs. The first time you run the FFMWR app *without* a `.env` file present, it will ask you if you would like to generate one and prompt you for several initial values for the file. It will then create a `.env` file in the root directory of the app which will be populated by a selection of default values (all of which can be changed as needed).
The app ***REQUIRES*** that a `.env` be present, so it is recommended that you allow the app to generate a default `.env` file for you and then update the values to reflect the league for which you wish to generate a report, as well as modify any other settings you wish to change from the default values.
For those of you who wish for the report to include a custom subset of the available features (for instance, if you want league stats but not team pages, or if you want score rankings but not coaching efficiency), the `REPORT SETTINGS` section in the `.env` file allows all features to be turned on or off. You must use a boolean value (`True` or `False`) to turn on/off any of the available report features. Please reference the `REPORT SETTINGS` section of your generated `.env` file for the available features.
The report can also have some of its visual formatting set. Please reference the `REPORT SETTINGS` section of your generated `.env` file for the available features.
The values seen in the `SUPPORTED_FONTS_LIST` environment variable are the currently supported fonts for the app.
The player headshots retrieved for individual team pages can come in varying resolutions, and when they are extremely high resolution, they can inflate the size of the report PDF. In order to allow the user to reduce the size of the final report PDF if desired, the following option is available:
IMAGE_QUALITY=75
The default value for the image quality is 75%, allowing for a reasonable reduction in image size without sacrificing overall aesthetic quality. However, this value can be set on a scale of 0%-100%, depending on the preferences of the user.
Once the initial images have been retrieved and quality has been adjusted, the report will cache those images and continue to use those indefinitely until you delete the `output/data///week_/player_headshots` for that week, since otherwise the images would continue to have their quality reduced until the headshots degraded entirely.
In addition to turning on/off the features of the report PDF itself, there are additional setting. For an overview of the available settings and what they do, please reference your generated `.env` file.
---
After completing the above setup and settings steps, you should now be able to simply run `docker exec -it fantasy-football-metrics-weekly-report_app_1 python main.py` to regenerate a report. The report generator script (`main.py`) also supports several command line options/arguments that allow you to specify the following:
| Flag | Description |
|:----------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|
| `-h`, `--help` | Display command line usage message |
| `-d`, `--use-default` | Automatically run the report using the default settings without user input prompts. |
| `-f`, `--fantasy-platform` `` | Fantasy football platform on which league for report is hosted. |
| `-l`, `--league-id` `` | Fantasy Football league ID |
| `-w`, `--week` `` | Chosen week for which to generate report |
| `-g`, `--game-id` `` | Chosen fantasy game id for which to generate report. Defaults to "nfl", interpreted as the current season if using Yahoo. |
| `-y`, `--year` `` | Chosen year (season) of the league for which a report is being generated. |
| `-s`, `--save-data` | Save all retrieved data locally for faster future report generation |
| `-s`, `--refresh-web-data` | Refresh all web data from external APIs (such as bad boy and beef data) |
| `-p`, `--playoff-prob-sims` `` | Number of Monte Carlo playoff probability simulations to run." |
| `-b`, `--break-ties` | Break ties in metric rankings |
| `-q`, `--disqualify-ce` | Automatically disqualify teams ineligible for coaching efficiency metric |
| `-o`, `--offline` | Run ***OFFLINE*** (for development). Must have previously run report with -s option. |
| `-t`, `--test` | Generate TEST report (for development) |
#### NOTE: all command line arguments ***OVERRIDE*** any settings in the local .env file!
##### Example:
```bash
docker exec -it fantasy-football-metrics-weekly-report_app_1 python main.py -l 140941 -f fleaflicker -y 2020 -w 3 -p 1000 -s -r
```
The above command runs the report with the following settings (which override anything set in the `.env` file):
* Platform: `fleaflicker`
* League id: `140941`
* NFL season: `2020`
* NFL week: `3`
* Number of Monte Carlo simulations for playoff probabilities: `1000`
* Saves the data locally (`-s`)
* Refreshes any previously saved local data (`-r`)
---
The Fantasy Football Metrics Weekly Report application also supports several additional integrations if you choose to utilize them. Currently, it is capable of uploading your generated reports to Google Drive, and also directly posting your generated reports to the Slack Messenger app.
The Fantasy Football Metrics Weekly Report application includes Google Drive integration, allowing your generated reports to be uploaded and stored in Google Drive, making it easy to share the report with all league members.
The following setup steps are ***required*** in order to allow the Google Drive integration to function properly:
1. Log in to your Google account (or make one if you don't have one).
2. Create a [new project](https://console.developers.google.com/projectcreate?folder=&organizationId=0) in the Google
Developers Console.
3. Accept the terms & conditions.
4. Name your project, something like `ff-metrics-weekly-report`, but it can be anything you like.
5. Click `CREATE`.
6. It will take a few moments for the project to be created, but once it is there will be a notification.
7. Go to the [Google Developers Console](https://console.developers.google.com/apis/dashboard).
8. Your new project should automatically load in the dashboard, but in the event it does not, or you have other projects (a different project might load by default), click the project name on the top left of the page (to the right of where it says "Google APIs"), and select your new project.
9. Either click the `+ ENABLE APIS AND SERVICES` button on the top of the page, or select "Library" from the menu on the left, search for `Google Drive API`, and click `Google Drive API` when it comes up.
10. Click `ENABLE`.
11. After a moment it will be enabled. Click `Credentials` from the left menu and then click `CREATE CREDENTIALS`.
12. From the menu that drops down, select `OAuth client ID`.
13. Click on `Configure Consent Screen`.
14. Select `Internal` for the `User Type` then click `CREATE`.
15. Put `ff-metrics-weekly-report` in `Application name`.
16. Select your email from the dropdown under `User support email`.
17. Enter your email again in the `Developer contact information` field.
18. Click `SAVE AND CONTINUE`.
19. Click `ADD OR REMOVE SCOPES`, search for `google drive` in the filter, check the box next to the `../auth/drive` scope, and click `UPDATE` at the bottom.
20. Click `SAVE AND CONTINUE`.
21. Now go click `Credentials` again from the left menu and click `CREATE CREDENTIALS`, then select `OAuth client ID`.
22. Select `Desktop app` from the dropdown menu, and put `ff-metrics-weekly-report-client-id`.
23. Click `CREATE`.
24. A popup with your `Client ID` and `Client secret` will appear. Copy the respective values to the `GOOGLE_DRIVE_CLIENT_ID` and `GOOGLE_DRIVE_CLIENT_SECRET` environment variables in your `.env` file, and then click `OK`. *Please note that if you accidentally close the popup you will still be able to click on the created credential in order to obtain your client ID and client secret.*
25. Open a terminal window (makes sure you are inside the `fantasy-football-metrics-weekly-report` directory), and run:
```bash
docker exec -it fantasy-football-metrics-weekly-report_app_1 python resources/google_quickstart.py --noauth_local_webserver
```
26. You will see a message that says `Go to the following link in your browser:`, followed by a link. Copy the URL and paste it into a web browser, and hit enter. The open window will ask you to either select a Google account to log into (if you have multiple) or log in. Select your account/login.
27. A warning screen will appear saying *"This app isn't verified"*. Click `Advanced` and then `Go to ff-metrics-weekly-report (unsafe)` (this screen may vary depending on your web browser, but the point is you need to proceed past the warning).
28. On the next screen, a popup saying *"Grant ff-metrics-weekly-report permission"* will appear. Click `Allow`, then `Allow` again on the following *"Confirm your choices"* screen.
29. Next you will see a screen that says only *"Please copy this code, switch to your application and paste it there:"*. Copy the code, and return to your open terminal window (you can close the browser window once you've copied the verification code).
30. Paste the verification code where it says `Enter verification code:`, and hit enter.
31. You should then see the command line output *"Authentication successful."*, as well as a list of 10 files in your Google Drive to confirm it can access your drive. It will also have automatically generated OAuth credentials and written them as JSON to the `GOOGLE_DRIVE_AUTH_TOKEN_JSON` environment variable in your `.env` file, which you should just leave as is and do ***NOT*** edit or modify in any way!
32. You can now upload your reports to Google Drive in one of two ways listed below. ***Please note, if you wish to specify where the app will upload the report to in Google Drive, change the value of `GOOGLE_DRIVE_FOLDER_PATH` in the `.env` file to whatever path you wish to store the reports in Google Drive, such as `Fantasy_Football/reports`. If you do not put a path in this value the report will default to uploading files to a `Fantasy_Football` directory at the root of your Google Drive.***
1. Change `GOOGLE_DRIVE_UPLOAD_BOOL` to `True` in the `.env` file and generate a new report. You will see a message at the end of the run that indicates the report PDF was successfully uploaded to Google Drive, and provides the direct share link to the file.
**OR**
2. Set the value of `GOOGLE_DRIVE_REUPLOAD_FILE_LOCAL_PATH` in the `.env` file to the local filepath of the report you wish to upload, opening a Terminal window, and running `python integrations/drive.py`*. This only works for preexisting reports that you have already generated, and will then upload that report to Google Drive without generating a new one.
---
The Fantasy Football Metrics Weekly Report application includes integration with the popular personal and business chat app Slack, allowing your generated reports (or links to where they are stored on Google Drive) to be uploaded directly to Slack, making it easy to share the report with all league members.
The following setup steps are ***required*** in order to allow the Slack integration to function properly:
1. Sign in to your slack workspace [here](https://slack.com/signin).
2. Once logged in, you need to [create a new app](https://api.slack.com/apps?new_app=1) for your workspace.
3. After the popup appears, select `From scratch` and fill in the fields as follows:
* `App Name`: `ff-metrics-weekly-report` (this name can be anything you want)
* `Pick a workspace to develop your app in:`: Select your chosen Slack workspace from the dropdown menu.
4. Click `Create App`. You should now be taken to the page for your new app, where you can set things like the app title card color, the icon, the description, as well as a whole host of other features (see [here](https://api.slack.com/docs/apps) for more information).
5. Select `Basic Information` from the `Settings` section in the menu on the left.
6. Scroll down to `Display Information` and set up your Slack app with whatever display settings you want.
7. Click `Save Changes`.
8. Select `OAuth & Permissions` from the `Features` section in the menu on the left.
9. Scroll down to `Scopes`.
10. Under `Bot Token Scopes`, click the `Add an OAuth Scope` button.
11. From the dropdown menu, select the below scopes:
| OAuth Scope | Description |
|:-----------------------|:------------------------------------------------------------------------------------|
| `channels:read` | View basic information about public channels in the workspace |
| `chat:write` | Send messages as @ff-report |
| `chat:write.customize` | Send messages as @ff-report with a customized username and avatar |
| `chat:write.public` | Send messages to channels @ff-report isn't a member of |
| `files:write` | Upload, edit, and delete files as ff-report |
| `groups:read` | View basic information about private channels that ff-report has been added to |
| `im:read` | View basic information about direct messages that ff-report has been added to |
| `incoming-webhook` | Post messages to specific channels in Slack |
| `mpim:read` | View basic information about group direct messages that ff-report has been added to |
12. Select `Install App` from the `Settings` section in the menu on the left and click the `Install to [Workspace]` (with your selected workspace) button.
13. You will be redirected to a screen saying your app is asking for permission to access the Slack workspace, and presenting you with a dropdown to select a channel for your app to post to. Select your desired channel, and hit `Allow`.
14. You will now be redirected back to the `Installed App Settings` section of your app settings. At the top, you will see a `Bot User OAuth Token` field, which will now have a value populated.
15. Copy the value of `Bot User OAuth Token`and paste in into the `SLACK_AUTH_TOKEN` environment variable in your `.env` file.
16. If you are posting to a *private channel*, you will need to invite the bot to the channel before it can make posts there. Just go to the Slack channel and type `@ff-metrics-weekly-report` (or whatever name you gave your app), and then hit enter. Slack will ask if you wish to invite the bot to the channel, so confirm that you wish to add the bot to the channel, and now it should be able to post to the *private channel*.
17. *You can now upload your reports to Slack, either by updating the following values in the `.env` file:*
* `SLACK_POST_BOOL=True`
* `SLACK_CHANNEL=` (this can be set to whichever channel you wish to post as long as the user who created the app has access to that channel)
*Or by setting the value of `REUPLOAD_FILE_PATH` in the `.env` file to the filepath of the report you wish to upload, opening a Terminal window, and running `python integrations/slack.py`*.
---
The Fantasy Football Metrics Weekly Report application includes integration with the popular chat and messaging app GroupMe, allowing your generated reports (or links to where they are stored on Google Drive) to be uploaded directly to GroupMe, making it easy to share the report with all league members.
The following setup steps are ***required*** in order to allow the GroupMe integration to function properly:
1. Sign in to the developer portal with your GroupMe account [here](https://dev.groupme.com/session/new).
2. Enter your PIN if you use 2-factor authentication.
3. Once logged in, click on `Access Token` on the top right of the menubar to the left of your username.
4. When the modal pops up, copy the value of `Your access token` paste in into the `GROUPME_ACCESS_TOKEN` environment variable in your `.env` file.
5. If you only want to post to GroupMe as your own user account, then you must change the value of the `GROUPME_BOT_OR_USER` environment variable in your `.env` file to `user` and you can skip to the last step. However, if you wish to post to GroupMe as a bot account, then you must follow the additional setup steps below:
1. In order to post reports to GroupMe from a bot account, you need to [create a new bot](https://dev.groupme.com/bots/new) by filling in the fields as follows:
* Select the target GroupMe group from the `Choose the group this bot will live in.` dropdown.
* `Name`: `Fantasy Football Metrics Weekly Report` (this name can be anything you want)
* `Callback URL`: Leave this field blank.
* `Avatar URL` *(Optional)*: If you wish for your bot to use have a profile picture, you can add a link to any image you wish to use here.
2. Click `Submit`, and you will be redirected to the `Bots` page where you should see your newly created bot listed.
3. Copy the `Bot ID` and paste in into the `GROUPME_BOT_ID` environment variable in your `.env` file.
6. *You can now upload your reports to GroupMe, either by updating the following values in the `.env` file:*
* `GROUPME_POST_BOOL=True`
* `GROUPME_GROUP=` (this can be set to whichever group you wish to post as long as the user/bot has access to that group)
*Or by setting the value of `REUPLOAD_FILE_PATH` in the `.env` file to the filepath of the report you wish to upload, opening a Terminal window, and running `python integrations/groupme.py`*.
---
The Fantasy Football Metrics Weekly Report application includes integration with the popular chat and messaging app Discord, allowing your generated reports (or links to where they are stored on Google Drive) to be uploaded directly to Discord, making it easy to share the report with all league members.
The following setup steps are ***required*** in order to allow the Discord integration to function properly (see the Discord documentation on [Intro to Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) for more detailed information and instructions):
1. Sign in to Discord and select the server on which you want to post reports.
2. Click the server name on the top left and then click `Server Settings`.
3. Select `Integrations` in the menu on the left (in the `APPS` section).
4. Click on `Webhooks`.
5. Click `New Webhook`.
6. A new webhook will be created. Click the webhook to expand it and update the configuration:
1. `NAME`: `Fantasy Football Metrics Weekly Report` (this name can be anything you want)
2. Profile picture: Upload [football.png](resources/images/football.png) (this picture can be anything you want)
3. `CHANNEL`: Select the target Discord channel from the `CHANNEL` dropdown.
7. Click `Copy Webhook URL` to copy the value of the webhook URL and paste the webhook ID portion of the URL into the `DISCORD_WEBHOOK_ID` environment variable in your `.env` file.
8. *You can now upload your reports to Discord, either by updating the following values in the `.env` file:*
* `DISCORD_POST_BOOL=True`
*Or by setting the value of `REUPLOAD_FILE_PATH` in the `.env` file to the filepath of the report you wish to upload, opening a Terminal window, and running `python integrations/discord.py`*.
---
In addition to displaying output from the application to the command line, the Fantasy Football Metrics Weekly Report also logs all the same output to [out.log](logs/out.log), which you can view at any time to see output from past runs of the application.
Occasionally when you use the Yahoo fantasy football API, there are hangups on the other end that can cause data not to transmit, and you might encounter an error similar to this:
Traceback (most recent call last):
File "yfpy-app.py", line 114, in
var = app.run()
File "/Users/your_username/PATH/T0/LOCAL/PROJECT/yfpy-app.py", line 429, in run
for team in team_standings:
IndexError: list index out of range
Typically, when the above error (or a similar error) occurs, it simply means that one of the Yahoo Fantasy Football API calls failed and so no data was retrieved. This can be fixed by simply re-running data query.
If you are trying to automatically retrieve your ESPN session cookies for authentication with an ESPN private league, you might encounter an error similar to the following:
selenium.common.exceptions.SessionNotCreatedException: Message: session not created: Chrome failed to start: exited normally.
(session not created: DevToolsActivePort file doesn't exist)
(The process started from chrome location /Applications/Google Chrome.app/Contents/MacOS/Google Chrome is no longer running, so ChromeDriver is assuming that Chrome has crashed.)
Stacktrace:
0 chromedriver 0x0000000104998274 cxxbridge1$str$ptr + 1907280
1 chromedriver 0x000000010499075c cxxbridge1$str$ptr + 1875768
2 chromedriver 0x00000001045a4260 cxxbridge1$string$len + 89488
3 chromedriver 0x00000001045d4d04 cxxbridge1$string$len + 288820
4 chromedriver 0x00000001045d16b8 cxxbridge1$string$len + 274920
5 chromedriver 0x0000000104612184 cxxbridge1$string$len + 539828
6 chromedriver 0x0000000104611ac4 cxxbridge1$string$len + 538100
7 chromedriver 0x00000001045dd12c cxxbridge1$string$len + 322652
8 chromedriver 0x00000001045ddd7c cxxbridge1$string$len + 325804
9 chromedriver 0x0000000104960504 cxxbridge1$str$ptr + 1678560
10 chromedriver 0x0000000104964e6c cxxbridge1$str$ptr + 1697352
11 chromedriver 0x0000000104945618 cxxbridge1$str$ptr + 1568244
12 chromedriver 0x000000010496573c cxxbridge1$str$ptr + 1699608
13 chromedriver 0x0000000104936bbc cxxbridge1$str$ptr + 1508248
14 chromedriver 0x0000000104981854 cxxbridge1$str$ptr + 1814576
15 chromedriver 0x00000001049819ac cxxbridge1$str$ptr + 1814920
16 chromedriver 0x00000001049903fc cxxbridge1$str$ptr + 1874904
17 libsystem_pthread.dylib 0x000000018cff2f94 _pthread_start + 136
18 libsystem_pthread.dylib 0x000000018cfedd34 thread_start + 8
In the case of the above, it typically occurs when the app is using Selenium to log in to your ESPN account within Chrome, but you already have Chrome open. Chrome does not allow two processes to use the same user profile, and since this automation is configured to use your user profile it will cause a conflict. You can remedy this by simply quitting Google Chrome and then trying again.
If you are running Docker on Windows, you might encounter errors when trying to build the Docker image and/or run `docker compose up -d`. Typically, these errors revolve around the way Windows strictly enforces file access permissions. There are two known permissions issues (and workarounds) currently for running the FFMWR app.
1. If you are running on ***Windows 10 Enterprise, Pro, or Education*** (all of which support the Hyper-V feature), then the latest version of Docker for Windows requires you to specifically give Docker permission to access any files and directories you need it to be able to see.
1. In order to do so, open up Docker for Windows, and go to settings:
2. Then click the following items in order (stop between 3 and 4):
3. After clicking the `+` button to add a directory, select the FFMWR app directory (which will be wherever you cloned it), or any parent directory of the app directory, and add it. Then click `Apply & Restart`.
4. Now go back to your command line shell, make sure you are in the FFMWR app directory, and re-run `docker compose up -d`. This time things should build and startup as expected without any errors, and you can pick up where you left of with [Running the Report Application](#running-the-report-application)!
2. If you are running on ***Windows 10 Home*** (which does **not** support the Hyper-V feature), then Docker for Windows does not have the File Sharing option discussed above for Windows 10 Enterprise, Pro, and Education users. However, you might still run into similar permissions issues. The below steps should provide a workaround to just sharing the files in Docker Desktop for Windows:
1. Type `Windows + X`. You will see a small pop-up list containing various administrator tasks.
2. Select `Command Prompt (Admin)`.
3. Use `cd` commands to navigate to whichever directory you cloned the FFMWR app into (e.g. `cd ~\Documents\fantasy-football-metrics-weekly-report\`).
4. Now from within that command prompt shell (which has privileged admin access), you should be able to re-run `docker compose up -d`, wait for everything to build and start running, and then pick up where you left of with [Running the Report Application](#running-the-report-application). Remember to stay in the admin command prompt shell to give your command the right file access!
On macOS 12+ (Monterey) or on Macs using the M1/M2 ARM architecture, you might encounter the following error (or one like it) during dependency installation:
```shell
Symbol not found in flat namespace '_FT_Done_Face' from reportlab with [email protected] on macOS 12
```
You may need to force `pip` to _reinstall_ the reportlab library using the following command:
```shell
pip install reportlab --force-reinstall --no-cache-dir --global-option=build_exta
```