add auto-generated sphinx documentation

cuddebtj · May 5, 2022 · ba47795 · ba47795
1 parent 6c7f1bb
commit ba47795
Show file tree

Hide file tree

Showing 284 changed files with 53,053 additions and 2,326 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ dist/
 *.egg-info/
 
 # Testing
+.pytest_cache/
 test_output/
 private*.json
 token*.json

diff --git a/.venv b/.venv
@@ -0,0 +1,2 @@
+yfpy
+
diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md
@@ -0,0 +1,27 @@
+# YFPY Deployment
+
+1. Build the package:
+
+    ```shell
+    python setup.py sdist bdist_wheel
+    ```
+
+2. Check packages before distribution:
+
+   ```shell
+   twine check dist/*
+   ```
+
+4. Update the git tag:
+
+    ```shell
+    
+    ```
+
+5. Deploy to PyPI:
+
+    ```shell
+    
+    ```
+
+6. The
diff --git a/README.md b/README.md
@@ -103,11 +103,13 @@ YFPY has a collection of fully functional code snippets that can be run using [p
 * See the [`test/integration`](test/integration) directory for the example code snippets.
 * Before running any tests, make a copy of [`test/integration/EXAMPLE.env`](test/integration/EXAMPLE.env) in the [`test/integration`](test/integration) 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`
+* If this is the first time running pytest with your Yahoo API credentials, you ***MUST*** allow interactive prompts within pytest by using the `-s` flag.
+* You can invoke all pytest tests (both integration test and unit tests) by running the below from the root directory:
+  * `pytest -v -s`
+* If you want to run only the integration tests, you can run:
+  * `pytest -v -s -m integration`
+* If you want to run only the unit tests, you can run:
+  * `pytest -v -s -m unit`
 
 ---
 

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,19 +1,47 @@
+alabaster==0.7.12
 attrs==21.2.0
+Babel==2.9.1
+bandit==1.7.4
 certifi==2021.10.8
-charset-normalizer==2.0.7
+charset-normalizer==2.0.9
+docutils==0.17.1
+flake8==4.0.1
+gitdb==4.0.9
+GitPython==3.1.24
 idna==3.3
+imagesize==1.3.0
 iniconfig==1.1.1
-packaging==21.0
-pluggy==0.13.1
-py==1.10.0
+Jinja2==3.0.3
+MarkupSafe==2.0.1
+mccabe==0.6.1
+packaging==21.3
+pbr==5.8.0
+pluggy==1.0.0
+py==1.11.0
 pyaml==21.10.1
-pyparsing==2.4.7
-pytest==6.2.5
-python-dotenv==0.19.1
+pycodestyle==2.8.0
+pyflakes==2.4.0
+Pygments==2.10.0
+pyparsing==3.0.6
+pytest==7.1.2
+python-dotenv==0.20.0
+pytz==2021.3
 PyYAML==6.0
 rauth==0.7.3
-requests==2.26.0
+requests==2.27.1
+six==1.16.0
+smmap==5.0.0
+snowballstemmer==2.2.0
+Sphinx==4.5.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+stevedore==3.5.0
 stringcase==1.2.0
 toml==0.10.2
+tomli==2.0.1
 urllib3==1.26.7
 yahoo-oauth==1.1
diff --git a/docs/Makefile → docs-sphinx/Makefile b/docs/Makefile → docs-sphinx/Makefile
diff --git a/docs/make.bat → docs-sphinx/make.bat b/docs/make.bat → docs-sphinx/make.bat
@@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=build
 
-if "%1" == "" goto help
-
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -25,6 +23,8 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

diff --git a/docs-sphinx/source/_autosummary/yfpy.data.Data.rst b/docs-sphinx/source/_autosummary/yfpy.data.Data.rst
@@ -0,0 +1,29 @@
+yfpy.data.Data
+==============
+
+.. currentmodule:: yfpy.data
+
+.. autoclass:: Data
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~Data.get
+      ~Data.load
+      ~Data.retrieve
+      ~Data.save
+      ~Data.update_data_dir
+
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.data.rst b/docs-sphinx/source/_autosummary/yfpy.data.rst
@@ -0,0 +1,32 @@
+yfpy.data
+=========
+
+.. automodule:: yfpy.data
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+      :nosignatures:
+
+      Data
+
+
+
+
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.rst b/docs-sphinx/source/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.rst
@@ -0,0 +1,6 @@
+yfpy.exceptions.YahooFantasySportsDataNotFound
+==============================================
+
+.. currentmodule:: yfpy.exceptions
+
+.. autoexception:: YahooFantasySportsDataNotFound
diff --git a/docs-sphinx/source/_autosummary/yfpy.exceptions.YahooFantasySportsException.rst b/docs-sphinx/source/_autosummary/yfpy.exceptions.YahooFantasySportsException.rst
@@ -0,0 +1,6 @@
+yfpy.exceptions.YahooFantasySportsException
+===========================================
+
+.. currentmodule:: yfpy.exceptions
+
+.. autoexception:: YahooFantasySportsException
diff --git a/docs-sphinx/source/_autosummary/yfpy.exceptions.rst b/docs-sphinx/source/_autosummary/yfpy.exceptions.rst
@@ -0,0 +1,31 @@
+yfpy.exceptions
+===============
+
+.. automodule:: yfpy.exceptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+      :toctree:
+
+      YahooFantasySportsDataNotFound
+      YahooFantasySportsException
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.logger.get_logger.rst b/docs-sphinx/source/_autosummary/yfpy.logger.get_logger.rst
@@ -0,0 +1,6 @@
+yfpy.logger.get\_logger
+=======================
+
+.. currentmodule:: yfpy.logger
+
+.. autofunction:: get_logger
diff --git a/docs-sphinx/source/_autosummary/yfpy.logger.rst b/docs-sphinx/source/_autosummary/yfpy.logger.rst
@@ -0,0 +1,31 @@
+yfpy.logger
+===========
+
+.. automodule:: yfpy.logger
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      get_logger
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.models.Bonus.rst b/docs-sphinx/source/_autosummary/yfpy.models.Bonus.rst
@@ -0,0 +1,29 @@
+yfpy.models.Bonus
+=================
+
+.. currentmodule:: yfpy.models
+
+.. autoclass:: Bonus
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~Bonus.clean_data_dict
+      ~Bonus.from_json
+      ~Bonus.serialized
+      ~Bonus.subclass_dict
+      ~Bonus.to_json
+
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.models.ByeWeeks.rst b/docs-sphinx/source/_autosummary/yfpy.models.ByeWeeks.rst
@@ -0,0 +1,29 @@
+yfpy.models.ByeWeeks
+====================
+
+.. currentmodule:: yfpy.models
+
+.. autoclass:: ByeWeeks
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~ByeWeeks.clean_data_dict
+      ~ByeWeeks.from_json
+      ~ByeWeeks.serialized
+      ~ByeWeeks.subclass_dict
+      ~ByeWeeks.to_json
+
+
+
+
+
+
diff --git a/docs-sphinx/source/_autosummary/yfpy.models.Division.rst b/docs-sphinx/source/_autosummary/yfpy.models.Division.rst
@@ -0,0 +1,29 @@
+yfpy.models.Division
+====================
+
+.. currentmodule:: yfpy.models
+
+.. autoclass:: Division
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~Division.clean_data_dict
+      ~Division.from_json
+      ~Division.serialized
+      ~Division.subclass_dict
+      ~Division.to_json
+
+
+
+
+
+