Update YFPY for 2021 - drop support for Python 3.5 and add support for newer Python versions

Author: uberfastman

.gitignore

@@ -18,4 +18,5 @@ dist/
 test/test_output/
 private*.json
 token*.json
-.env
+test/*.env
+!TEST/EXAMPLE.env

.travis.yml

@@ -1,10 +1,11 @@
 language: python
 
 python:
-- "3.5"
 - "3.6"
 - "3.7"
 - "3.8"
+- "3.9"
+- "3.10"
 
 install:
   - pip install -r requirements.txt

README.md

@@ -40,8 +40,10 @@
 
 ### Table of Contents
 * [About](#about)
-* [Usage](#usage)
+* [Installation](#installation)
 * [Setup](#setup)
+* [Usage](#usage)
+* [Testing](#testing)
 * [Dependencies](#dependencies)
 * [Troubleshooting](#troubleshooting)
 
@@ -50,24 +52,23 @@
 <a name="about"></a>
 ### About
 
-YFPY is a comprehensive wrapper around the Yahoo Fantasy Sports API. It allows for easy retrieval and parsing of almost any data you might wish to extract and use from any Yahoo fantasy league to which your Yahoo account has access (or for public leagues). The primary focus of this wrapper is on fantasy football (NFL), but it also supports usage with fantasy hockey (NHL), fantasy baseball (MLB), and fantasy basketball (NBA).
-   
----
+YFPY is a comprehensive wrapper around the Yahoo Fantasy Sports API. It allows for easy retrieval and parsing of almost any data you might wish to extract and use from any Yahoo fantasy league to which your Yahoo account has access (or for public leagues). The primary focus of this wrapper is on fantasy football (NFL), but it also supports usage with fantasy hockey (NHL), fantasy baseball (MLB), and fantasy basketball (NBA). 
 
-<a name="usage"></a>
-### Usage
+---
 
-* In your project directory, run
+<a name="installation"></a>
+### Installation
 
-    ```
+* If you wish to use YFPY within another project, from within your project directory, run
+    ```shell
     pip install yfpy
     ```
 
     or add `yfpy` to your project `requirements.txt`.
-* Follow the instructions in the below [Setup](#setup) section.
-* See `test/test.py` for fully functional code snippets within the query tests that demonstrate how to use YFPY.
-* PLEASE NOTE: Assuming you followed the setup instructions correctly, the ***first*** time you use YFPY, a browser window will open up asking you to allow your app to access your Yahoo fantasy sports data. You ***MUST*** hit allow, and then copy the verification code that pops up into the command line prompt where it will now be asking for verification, hit enter, and the OAuth2 three-legged handshake should be complete and your data should have been successfully retrieved.
-* YFPY should have now generated a `token.json` for you in the same directory where you stored your `private.json` credentials, and for all subsequent runs of your app, you should be able to keep retrieving Yahoo fantasy sports data using YFPY without re-verifying, since the generated refresh token should now just renew whenever you use the same `token.json` file to authenticate your app.
+* If you wish to download and use YFPY locally, clone the git repository:
+  ```shell
+  git clone git@github.com:uberfastman/yfpy.git
+  ```
 
 ---
 
@@ -84,15 +85,40 @@ YFPY is a comprehensive wrapper around the Yahoo Fantasy Sports API. It allows f
     * `API Permissions` (**Required**): check the `Fantasy Sports` checkbox. You can 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`.
-    * Make a copy of `examples/EXAMPLE-private.json`, rename it to just `private.json`, and copy the `Client ID` and `Client Secret` values 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 YFPY to your credentials.
+    * Make a copy of [`test/EXAMPLE-private.json`](test/EXAMPLE-private.json), rename it to just `private.json`, and copy the `Client ID` and `Client Secret` values 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 YFPY to your credentials.
     * Now you should be ready to initialize the OAuth2 connection between YFPY your Yahoo account.
 
 ---
 
+<a name="usage"></a>
+### Usage
+
+* Follow the instructions in the [Installation](#installation) and [Setup](#setup) sections.
+* The ***first*** time you use YFPY, a browser window will open up asking you to allow your app to access your Yahoo fantasy sports data. You ***MUST*** hit allow, and then copy the verification code that pops up into the command line prompt where it will now be asking for verification, hit enter, and the OAuth2 three-legged handshake should be complete and your data should have been successfully retrieved.
+* YFPY should have now generated a `token.json` for you in the same directory where you stored your `private.json` credentials, and for all subsequent runs of your app, you should be able to keep retrieving Yahoo fantasy sports data using YFPY without re-verifying, since the generated refresh token should now just renew whenever you use the same `token.json` file to authenticate your app.
+
+---
+
+<a name="testing"></a>
+### Testing
+
+YFPY has a collection of fully functional code snippets that can be run using [pytest](https://docs.pytest.org/en/6.2.x/). These snippets demonstrate how to use YFPY to retrieve your Yahoo Fantasy Sports data.
+
+* See [`test/test_yfpy.py`](test/test_yfpy.py) for the example code snippets.
+* Before running any tests, make a copy of [`test/EXAMPLE.env`](test/EXAMPLE.env) in the [`test`](test) directory and rename it to `.env`.
+* Copy your Yahoo `Client ID` and `Client Secret` into the environment variables in `.env` so that pytest can use them when hitting the Yahoo Fantasy Sports API.
+* You can invoke the pytest tests by first changing to the test directory from the root of the YFPY repository:
+  * `cd test`
+  * `pytest test_yfpy.py`
+* If you want to run the tests from elsewhere, you will need to allow pytest to use interactive prompts:
+  * `pytest -s test/test_yfpy.py`
+
+---
+
 <a name="dependencies"></a>
 ### Dependencies
 
-YFPY has only been tested on macOS, but is written to be platform agnostic. It runs only in Python 3, and has only been tested with Python 3.7.
+YFPY has only been tested on macOS, but is written to be platform-agnostic. It runs only in Python 3, and has only been tested from Python 3.6 through Python 3.10.
 
 Direct project dependencies can be viewed in `requirements.txt`, and all dependencies, including transitive dependencies, can be viewed in `dev-requirements.txt`.
 

dev-requirements.txt

@@ -1,21 +1,19 @@
-attrs==20.2.0
-certifi==2020.6.20
-chardet==3.0.4
-idna==2.10
-iniconfig==1.0.1
-more-itertools==8.5.0
-packaging==20.4
+attrs==21.2.0
+certifi==2021.10.8
+charset-normalizer==2.0.7
+idna==3.3
+iniconfig==1.1.1
+packaging==21.0
 pluggy==0.13.1
-py==1.9.0
-pyaml==20.4.0
+py==1.10.0
+pyaml==21.10.1
 pyparsing==2.4.7
-pytest==6.1.0
-python-dotenv==0.14.0
-PyYAML==5.3.1
+pytest==6.2.5
+python-dotenv==0.19.1
+PyYAML==6.0
 rauth==0.7.3
-requests==2.24.0
-six==1.15.0
+requests==2.26.0
 stringcase==1.2.0
-toml==0.10.1
-urllib3==1.25.10
+toml==0.10.2
+urllib3==1.26.7
 yahoo-oauth==1.1

requirements.txt

@@ -1,5 +1,5 @@
 yahoo-oauth==1.1
 stringcase~=1.2.0
-requests
-pytest~=6.1.0
-python-dotenv~=0.14.0
+requests~=2.26.0
+pytest~=6.2.5
+python-dotenv~=0.19.1

setup.py

@@ -1,10 +1,11 @@
 import os
 import shutil
 import subprocess
+from pathlib import Path
 
 import setuptools
 
-version_file = os.path.join(os.path.dirname(__file__), "VERSION")
+version_file = Path(__file__).parent / "VERSION"
 
 # noinspection PyBroadException
 try:
@@ -16,22 +17,18 @@
         pypi_version = git_version[1:]
 
 with open(version_file, "w") as vf:
-    vf.write("{}{}__version__ = \"{}\"{}".format(
-        "# DO NOT EDIT - VERSIONING CONTROLLED BY GIT TAGS",
-        os.linesep,
-        git_version,
-        os.linesep
-    ))
+    vf.write(
+        f"# DO NOT EDIT - VERSIONING CONTROLLED BY GIT TAGS{os.linesep}__version__ = \"{git_version}\"{os.linesep}")
 
-if os.path.exists("build"):
+if Path("build").exists():
     print("Removing stale \"build\" directory before packaging...")
     shutil.rmtree("build")
 
-if os.path.exists("dist"):
+if Path("dist").exists():
     print("Removing stale \"dist\" directory before packaging...")
     shutil.rmtree("dist")
 
-if os.path.exists("yfpy.egg-info"):
+if Path("yfpy.egg-info").exists():
     print("Removing stale \"yfpy.egg-info\" directory before packaging...")
     shutil.rmtree("yfpy.egg-info")
 
@@ -45,20 +42,21 @@
     name="yfpy",
     version=pypi_version,
     author="Wren J. R.",
-    author_email="wrenjr@yahoo.com",
+    author_email="uberfastman@uberfastman.dev",
     description="Python API wrapper for the Yahoo Fantasy Sports public API.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     keywords="yahoo fantasy sports api wrapper nfl football nhl hockey mlb baseball nba basketball",
     url="https://github.com/uberfastman/yfpy",
-    download_url="https://github.com/uberfastman/yfpy/archive/{}.tar.gz".format(git_version),
+    download_url=f"https://github.com/uberfastman/yfpy/archive/{git_version}.tar.gz",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
         "Operating System :: OS Independent",
         "Development Status :: 5 - Production/Stable",

test/EXAMPLE.env

@@ -0,0 +1,2 @@
+YFPY_CONSUMER_KEY=YAHOO_DEVELOPER_APP_CONSUMER_KEY_STRING
+YFPY_CONSUMER_SECRET=YAHOO_DEVELOPER_APP_CONSUMER_SECRET_STRING