Fantasy Football Metrics Weekly Report

^➡️

Fantasy Football Platform Support: Yahoo, ESPN, Sleeper, Fleaflicker, CBS

You can see an example of what a report looks like here!

Do you like the app? Star the repository here on GitHub and please consider donating to help support its development!

Interested in contributing to the project?

Quickstart Guide

+ NEW (AND EASIER) APPLICATION SETUP BELOW!

Open a command-line interface (see the 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.
Install Git (see 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 and install it.
- Linux (Ubuntu): sudo apt install git-all (see above link for different Linux distributions)
Install Docker Desktop for your operating system.
- macOS: Docker Desktop for Mac
- Windows: Docker Desktop for Windows
- Linux: Docker for Linux
Clone this app from GitHub (see 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).
```
git clone https://github.com/uberfastman/fantasy-football-metrics-weekly-report.git
```
Navigate into the cloned app directory within the command line by running:
```
cd fantasy-football-metrics-weekly-report
```
Follow the required setup instructions for whichever fantasy football platform you use: Yahoo, ESPN, Sleeper, or Fleaflicker
Update the values in the .env file (see the 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.
Run the Fantasy Football Metrics Weekly Report app using Docker (see the Running the Report Application section for more details). ^{If on Windows, see the Docker on Windows troubleshooting section if you encounter any permissions or access issues.}
- Run:
```
docker compose up -d
```
  If you wish to see the Docker logs, then run docker compose up.
- Wait for the above command to complete, then run:
```
docker exec -it fantasy-football-metrics-weekly-report-app-1 python main.py
```
- Follow the prompts to generate a report for your fantasy league!

About

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

Platforms in development:

TBD

Planned platforms:

MyFantasyLeague

Example Report

You can see an example of what a report looks like here!

Updating

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.

Dependencies

The application is actively developed in macOS, but is cross-platform compatible. The app requires Python 3.9 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 for how to install Python 3 on your system.

Project dependencies can be viewed in the requirements.txt file.

Setup*

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 for details on including those add-ons.

Command-line

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.

Git

Install git (if you do not already have it installed). You can see detailed instructions for installation on your OS here.

macOS: run git --version for the first time, and when prompted, install the Xcode Command Line Tools.
Windows: Download Git for Windows 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.

***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!

Docker

NOTE: This application requires you to have administrative (admin) access for the computer on which you are installing it.

Install Docker for your operating system:

GitHub

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:
```
git clone https://github.com/uberfastman/fantasy-football-metrics-weekly-report.git
```
If you already have an account on GitHub, then I recommend using SSH to connect with GitHub by running:
```
git clone [email protected]:uberfastman/fantasy-football-metrics-weekly-report.git
```

Platforms

Yahoo Setup

Yahoo Fantasy Sports has a public API documented here. The Fantasy Football Metrics Weekly Report application uses my own YFPY Python wrapper around this API to retrieve the necessary data to generate reports.

Log in to a Yahoo account with access to whatever fantasy football leagues from which you wish to retrieve data.
Retrieve your Yahoo Fantasy football league id, which you can find by going to https://football.fantasysports.yahoo.com, clicking on your league, and looking here:
Change the LEAGUE_ID value in your .env file to the above located league id.
Go to 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).
Click the Create App button.
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.
Copy the file private.template.json (located in the auth/yahoo/ directory) and rename the file copy private.json by running the below command in your command line shell:
- macOS/Linux: cp auth/yahoo/private.template.json private.json auth/yahoo/private.json
- Windows: copy auth\yahoo\private.template.json auth\yahoo\private.json
Open your new private.json file with your preferred text editor (such as TexEdit in macOS or Notepad in Windows), then copy and paste the Client ID and Client Secret values from your above created Yahoo app to their respective fields (make sure the strings are wrapped regular quotes (""), NOT formatted quotes (“”)). The path to this file will be needed to point the YFPY API wrapper responsible for data retrieval to your credentials.
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!

Fleaflicker Setup

Fleaflicker has a public API documented here. 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.

Retrieve your Fleaflicker league ID. You can find it by looking at the URL of your league in your browser:
Change the LEAGUE_ID value in the .env file to the above located league id.
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.
You can also specify the year/season from the command line by running the report with the -y <chosen_year> flag.
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!

Sleeper Setup

Sleeper has a public API documented here. 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.

Retrieve your Sleeper league ID. You can find it by looking at the URL of your league in your browser:
Change the LEAGUE_ID value in the .env file to the above located league id.
(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!

ESPN Setup

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.

Retrieve your ESPN league ID. You can find it by looking at the URL of your league in your browser:
Change the LEAGUE_ID value in the .env file to the above located league id.
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.
You can also specify the year/season from the command line by running the report with the -y <chosen_year> flag.
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. Copy the file private.template.json (located in the auth/espn/ directory), and rename the file copy private.json by running the below command in your command line shell:
    - macOS/Linux: cp auth/espn/private.template.json private.json auth/espn/private.json
    - Windows: copy auth\espn\private.template.json auth\espn\private.json
  2. Open your new private.json file with your preferred text editor (such as TexEdit in macOS or Notepad in Windows), delete the swid and espn_s2 fields, and add your ESPN account username and password to their respective fields. Please note, the FFMWR app does not store any of your credentials, it simply uses them to log in to your account and obtain session cookies. The app uses Selenium 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 private.json file for reuse with future ESPN API authentication.
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 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:
```
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. Copy the file private.template.json (located in the auth/espn/ directory), and rename the file copy private.json by running the below command in your command line shell:
    - macOS/Linux: cp auth/espn/private.template.json private.json auth/espn/private.json
    - Windows: copy auth\espn\private.template.json auth\espn\private.json
  5. Open your new private.json 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 fields. 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!

CBS Setup

CBS has a public API that was once documented, the last version of which can be viewed using the Wayback machine here. 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.

Retrieve your CBS league ID. You can find it by looking at the URL of your league in your browser:
Change the LEAGUE_ID value in the .env file to the above located league id.
The CBS API requires authentication to retrieve your league data, so you will need to use your CBS credentials to do so. Copy the file private.template.json (located in the auth/cbs/ directory), and rename the file copy private.json by running the below command in your command line shell:
- macOS/Linux: cp auth/cbs/private.template.json private.json auth/cbs/private.json
- Windows: copy auth\cbs\private.template.json auth\cbs\private.json
Open your new private.json file with your preferred text editor (such as TexEdit in macOS or Notepad in Windows), then update the respective fields with your LEAGUE_ID, CBS username, and CBS password. Please note, the FFMWR app does not store any of your credentials, it simply uses them to log in to your account and obtain an API access token. All values added to private.json must be surrounded by regular quotes (""), NOT formatted quotes (“”)).
The first time you run the app, it will retrieve an API access token using your credentials and store it in the auth/cbs/private.json 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 the file.

You are now ready to generate a report!

Running the Report Application

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.
From within the application directory (you should already be inside the fantasy-football-metrics-weekly-report directory) , run:
```
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. 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 section in 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:
```
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!
Run the report:
```
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 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:
      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.
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:
```
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 for more information.

Settings

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.

Report Features

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, which are the following:

LEAGUE_STANDINGS_BOOL=True
LEAGUE_PLAYOFF_PROBS_BOOL=True
LEAGUE_MEDIAN_STANDINGS_BOOL=True
LEAGUE_POWER_RANKINGS_BOOL=True
LEAGUE_Z_SCORE_RANKINGS_BOOL=True
LEAGUE_SCORE_RANKINGS_BOOL=True
LEAGUE_COACHING_EFFICIENCY_RANKINGS_BOOL=True
LEAGUE_LUCK_RANKINGS_BOOL=True
LEAGUE_OPTIMAL_SCORE_RANKINGS_BOOL=True
LEAGUE_BAD_BOY_RANKINGS_BOOL=True
LEAGUE_BEEF_RANKINGS_BOOL=True
LEAGUE_WEEKLY_TOP_SCORERS_BOOL=True
LEAGUE_WEEKLY_HIGHEST_CE_BOOL=True
REPORT_TIME_SERIES_CHARTS_BOOL=True
REPORT_TEAM_STATS_BOOL=True
TEAM_POINTS_BY_POSITION_CHARTS_BOOL=True
TEAM_BAD_BOY_STATS_BOOL=True
TEAM_BEEF_STATS_BOOL=True
TEAM_BOOM_OR_BUST_BOOL=True

Report Formatting

The report can also have some of its visual formatting set. The following formatting options are available:

FONT=helvetica
SUPPORTED_FONTS_LIST=helvetica,times,symbola,opensansemoji,sketchcollege,leaguegothic
FONT_SIZE=12
IMAGE_QUALITY=75
MAX_DATA_CHARS=24

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/<YEAR>/<LEAGUE_ID>/week_<WEEK_#>/player_headshots for that week, since otherwise the images would continue to have their quality reduced until the headshots degraded entirely.

Report Settings

In addition to turning on/off the features of the report PDF itself, there are additional setting, which are as follows:

Option	Description
`PLATFORM`	Fantasy football platform for which you are generating a report.
`SUPPORTED_PLATFORMS_LIST`	Comma-delimited list (with no spaces between items) of currently supported fantasy football platforms.
`LEAGUE_ID`	The league id of the fantasy football for which you are running the report.
`DATA_DIR_LOCAL_PATH`	Directory where saved data is stored.
`OUTPUT_DIR_LOCAL_PATH`	Directory where generated reports are created.
`WEEK_FOR_REPORT`	Selected NFL season week for which to generate a report.
`NUM_PLAYOFF_SIMULATIONS`	Number of Monte Carlo simulations to run for playoff predictions. The more sims, the longer the report will take to generate.
`NUM_REGULAR_SEASON_WEEKS`	Number of regular season weeks in selected league.
`NUM_PLAYOFF_SLOTS`	Number of playoff slots in selected league.
`NUM_PLAYOFF_SLOTS_PER_DIVISION`	Numbers of teams per division that qualify for the playoffs.
`COACHING_EFFICIENCY_DISQUALIFIED_TEAMS_LIST`	Comma-delimited list (with no spaces between items and surrounded by quotes) of teams manually disqualified from coaching efficiency rankings (if any).
`GOOGLE_DRIVE_UPLOAD_BOOL`	Turn on (`True`) or off (`False`) the Google Drive upload functionality.
`GOOGLE_DRIVE_AUTH_TOKEN_LOCAL_PATH`	Google OAuth refresh token.
`GOOGLE_DRIVE_FOLDER_PATH`	Online folder in Google Drive where reports are uploaded.
`GOOGLE_DRIVE_REUPLOAD_FILE_LOCAL_PATH`	File path of selected report that you wish to re-upload to Google Drive by running `upload_to_google_drive.py` as a standalone script.
`SLACK_POST_BOOL`	Turn on (`True`) or off (`False`) the Slack upload functionality.
`SLACK_AUTH_TOKEN_LOCAL_PATH`	Slack authentication token.
`SLACK_POST_OR_FILE`	Choose whether you post a link to the generated report on Slack (set to `post`), or upload the report PDF itself to Slack (set to `file`).
`SLACK_CHANNEL`	Selected Slack channel where reports are uploaded.
`SLACK_CHANNEL_NOTIFY_BOOL`	Turn on (`True`) or off (`False`) using the `@here` slack tag to notify chosen Slack channel of a posted report file.
`SLACK_REPOST_FILE_LOCAL_PATH`	File path of selected report that you wish to repost to Slack.

Usage

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` `<platform>`	Fantasy football platform on which league for report is hosted.
`-l`, `--league-id` `<league_id>`	Fantasy Football league ID
`-w`, `--week` `<week>`	Chosen week for which to generate report
`-g`, `--game-id` `<game_id>`	Chosen fantasy game id for which to generate report. Defaults to "nfl", interpreted as the current season if using Yahoo.
`-y`, `--year` `<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` `<int>`	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:

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)

Additional Integrations

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.

Google Drive Setup

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:

Log in to your Google account (or make one if you don't have one).
Create a new project in the Google Developers Console.
Accept the terms & conditions.
Name your project, something like ff-report-drive-uploader, but it can be anything you like.
Click CREATE.
It will take a few moments for the project to be created, but once it is there will be a notification.
Go to the Google Developers Console.
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.
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.
Click ENABLE.
After a moment it will be enabled. Click Credentials from the left menu and then click CREATE CREDENTIALS.
From the menu that drops down, select OAuth client ID.
Click on Configure Consent Screen.
Select Internal for the User Type then click CREATE.
Put yff-report-drive-uploader in Application name.
Select your email from the dropdown under User support email.
Enter your email again in the Developer contact information field.
Click SAVE AND CONTINUE.
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.
Click SAVE AND CONTINUE.
Now go click Credentials again from the left menu and click CREATE CREDENTIALS, then select OAuth client ID.
Select Desktop app from the dropdown menu, and put yff-report-drive-uploader-client-id.
Click CREATE.
A popup with your client ID and client secret will appear. Click OK.
On the far right of your new credential, click the little arrow that displays Download OAuth Client when you hover over it, then click DOWNLOAD JSON.
Your credentials JSON file will download. Rename it credentials.json, and put it in the auth/google/ directory where credentials.template.json is located.

Open a terminal window (makes sure you are inside the fantasy-football-metrics-weekly-report directory), and run:

docker exec -it fantasy-football-metrics-weekly-report_app_1 python resources/google_quickstart.py --noauth_local_webserver

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.
A warning screen will appear saying "This app isn't verified". Click "Advanced" and then "Go to yff-report-drive-uploader (unsafe)" (this screen may vary depending on your web browser, but the point is you need to proceed past the warning).
On the next screen, a popup saying "Grant yff-report-drive-uploader permission" will appear. Click "Allow", then "Allow" again on the following "Confirm your choices" screen.
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).
Paste the verification code where it says Enter verification code:, and hit enter.
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 a token.json file in auth/google/, which you should just leave where it is and do NOT edit or modify in any way!
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.

Slack Setup

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:

Sign in to your slack workspace here.
Once logged in, you need to create a new app for your workspace.
After the popup appears, fill in the fields as follows:
- i. App Name: ff-report (this name can be anything you want)
- ii. Development Slack Workspace: Select your chosen Slack workspace from the dropdown menu.
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 for more information).
Select Basic Information from the menu on the left.
Scroll down to Display Information and set up your Slack app with whatever display settings you want.
Scroll up to Building Apps for Slack and click Bots.
You will be taken to the App Home section of the menu on the left.
Click the Review Scopes to Add button.
You will be taken to the OAuth & Permissions section of the menu on the left.
Scroll down to Scopes.
Under Bot Token Scopes, click the Add an OAuth Scope button.
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 |
Scroll back up to OAuth Tokens & Redirect URLs, and now you should be able to click the Install App to Workspace button, so click it.
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.
You will now be redirected back to the OAuth & Permissions section of your app settings. At the top, you will see a Bot User OAuth Access Token field, which will now have a value populated.
Copy the file token.template.json (located in the auth/slack/ directory), and rename the file copy token.json, then copy and paste the above Bot user OAuth Access Token into the field value of token.json where it says "SLACK_APP_OAUTH_ACCESS_TOKEN_STRING", replacing that string. Make sure you are using double quotes (") on either side of your token string.
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-report, 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.
You can now upload your reports to Slack, either by updating the following values in the .env file:
- i. SLACK_POST_BOOL=True
- ii. SLACK_CHANNEL=channel-name (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 SLACK_REPOST_FILE_LOCAL_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.

Troubleshooting

Logs

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, which you can view at any time to see output from past runs of the application.

Yahoo

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

Docker on Windows

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.

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!
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. Remember to stay in the admin command prompt shell to give your command the right file access!

Reportlab

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:

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:

pip install reportlab --force-reinstall --no-cache-dir --global-option=build_exta

Name		Name	Last commit message	Last commit date
Latest commit History 456 Commits
.github		.github
auth		auth
calculate		calculate
dao		dao
docker		docker
integrations		integrations
report		report
resources		resources
tests		tests
utilities		utilities
.dockerignore		.dockerignore
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
RELEASE.md		RELEASE.md
compose.build.yaml		compose.build.yaml
compose.yaml		compose.yaml
main.py		main.py
requirements-dev.txt		requirements-dev.txt
requirements.txt		requirements.txt

License

kenzliang/fantasy-football-metrics-weekly-report

Folders and files

Latest commit

History

Repository files navigation

Fantasy Football Metrics Weekly Report

Fantasy Football Platform Support: Yahoo, ESPN, Sleeper, Fleaflicker, CBS

Do you like the app? Star the repository here on GitHub and please consider donating to help support its development!

Interested in contributing to the project?

Table of Contents

Quickstart Guide

About

Example Report

Updating

Dependencies

Setup*

Command-line

Git

Docker

GitHub

Platforms

Yahoo Setup

You are now ready to generate a report!

Fleaflicker Setup

You are now ready to generate a report!

Sleeper Setup

You are now ready to generate a report!

ESPN Setup

You are now ready to generate a report!

CBS Setup

You are now ready to generate a report!

Running the Report Application

Settings

Report Features

Report Formatting

Report Settings

Usage

NOTE: all command line arguments OVERRIDE any settings in the local .env file!

Example:

Additional Integrations

Google Drive Setup

Slack Setup

Troubleshooting

Logs

Yahoo

Docker on Windows

Reportlab

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages