diff --git a/VERSION.py b/VERSION.py index c3c21c5f..abd08abc 100644 --- a/VERSION.py +++ b/VERSION.py @@ -1,2 +1,2 @@ # DO NOT EDIT - VERSIONING CONTROLLED BY GIT TAGS -__version__ = "v7.0.2" +__version__ = "v5.0.0" diff --git a/docs/.buildinfo b/docs/.buildinfo index 3f370e12..11cc7fe9 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 60402bd3ead09ff3ecb393cc5d07ea66 +config: 1d8fa79c43802901403df211a29553f5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_autosummary/yfpy.data.Data.html b/docs/_autosummary/yfpy.data.Data.html index 69987e7b..624dcb42 100644 --- a/docs/_autosummary/yfpy.data.Data.html +++ b/docs/_autosummary/yfpy.data.Data.html @@ -4,9 +4,12 @@ - yfpy.data.Data — YFPY v7.0.0 documentation + yfpy.data.Data — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -72,7 +148,10 @@
  • yfpy.data.Data
    • -
+
diff --git a/docs/_autosummary/yfpy.data.html b/docs/_autosummary/yfpy.data.html index 976b00bb..9116e3f1 100644 --- a/docs/_autosummary/yfpy.data.html +++ b/docs/_autosummary/yfpy.data.html @@ -4,9 +4,12 @@ - yfpy.data — YFPY v7.0.0 documentation + yfpy.data — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -71,7 +147,10 @@
  • yfpy.data
    • -
+
diff --git a/docs/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.html b/docs/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.html index 433c6557..332a22d2 100644 --- a/docs/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.html +++ b/docs/_autosummary/yfpy.exceptions.YahooFantasySportsDataNotFound.html @@ -4,9 +4,12 @@ - yfpy.exceptions.YahooFantasySportsDataNotFound — YFPY v7.0.0 documentation + yfpy.exceptions.YahooFantasySportsDataNotFound — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -73,7 +148,10 @@
  • yfpy.exceptions.YahooFantasySportsDataNotFound
    • -
+
diff --git a/docs/_autosummary/yfpy.exceptions.YahooFantasySportsException.html b/docs/_autosummary/yfpy.exceptions.YahooFantasySportsException.html index dd1b9444..a03eb13c 100644 --- a/docs/_autosummary/yfpy.exceptions.YahooFantasySportsException.html +++ b/docs/_autosummary/yfpy.exceptions.YahooFantasySportsException.html @@ -4,9 +4,12 @@ - yfpy.exceptions.YahooFantasySportsException — YFPY v7.0.0 documentation + yfpy.exceptions.YahooFantasySportsException — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -73,7 +148,10 @@
  • yfpy.exceptions.YahooFantasySportsException
    • -
+
diff --git a/docs/_autosummary/yfpy.exceptions.html b/docs/_autosummary/yfpy.exceptions.html index 8b5289bd..f65c3fff 100644 --- a/docs/_autosummary/yfpy.exceptions.html +++ b/docs/_autosummary/yfpy.exceptions.html @@ -4,9 +4,12 @@ - yfpy.exceptions — YFPY v7.0.0 documentation + yfpy.exceptions — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -72,7 +147,10 @@
  • yfpy.exceptions
    • -
+
diff --git a/docs/_autosummary/yfpy.html b/docs/_autosummary/yfpy.html index 726b048e..479b3985 100644 --- a/docs/_autosummary/yfpy.html +++ b/docs/_autosummary/yfpy.html @@ -4,9 +4,12 @@ - yfpy — YFPY v7.0.0 documentation + yfpy — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
  • yfpy
    • -
+
diff --git a/docs/_autosummary/yfpy.logger.get_logger.html b/docs/_autosummary/yfpy.logger.get_logger.html index 77584140..9dac1542 100644 --- a/docs/_autosummary/yfpy.logger.get_logger.html +++ b/docs/_autosummary/yfpy.logger.get_logger.html @@ -4,9 +4,12 @@ - yfpy.logger.get_logger — YFPY v7.0.0 documentation + yfpy.logger.get_logger — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -72,7 +148,10 @@
  • yfpy.logger.get_logger
    • -
+
diff --git a/docs/_autosummary/yfpy.logger.html b/docs/_autosummary/yfpy.logger.html index 15c831a9..ea8a5fcf 100644 --- a/docs/_autosummary/yfpy.logger.html +++ b/docs/_autosummary/yfpy.logger.html @@ -4,9 +4,12 @@ - yfpy.logger — YFPY v7.0.0 documentation + yfpy.logger — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -71,7 +147,10 @@
  • yfpy.logger
    • -
+
diff --git a/docs/_autosummary/yfpy.models.Bonus.html b/docs/_autosummary/yfpy.models.Bonus.html index 22df8346..9853030a 100644 --- a/docs/_autosummary/yfpy.models.Bonus.html +++ b/docs/_autosummary/yfpy.models.Bonus.html @@ -4,9 +4,12 @@ - yfpy.models.Bonus — YFPY v7.0.0 documentation + yfpy.models.Bonus — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Bonus
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Bonus
points
-
+

The points awarded when the bonus is won.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.Bonus
target
-
+

The stat value target required to be awarded the bonus.

+
Type

int

@@ -162,8 +202,8 @@

yfpy.models.Bonus

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.Bonus +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.ByeWeeks.html b/docs/_autosummary/yfpy.models.ByeWeeks.html index 08c9cf89..aa04ded9 100644 --- a/docs/_autosummary/yfpy.models.ByeWeeks.html +++ b/docs/_autosummary/yfpy.models.ByeWeeks.html @@ -4,9 +4,12 @@ - yfpy.models.ByeWeeks — YFPY v7.0.0 documentation + yfpy.models.ByeWeeks — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.ByeWeeks
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.ByeWeeks
week
-
+

The week number that the player is on bye.

+
Type

int

@@ -152,8 +191,8 @@

yfpy.models.ByeWeeks

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -180,6 +219,20 @@

yfpy.models.ByeWeeks

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Division.html b/docs/_autosummary/yfpy.models.Division.html index a9b7358d..818e2e7f 100644 --- a/docs/_autosummary/yfpy.models.Division.html +++ b/docs/_autosummary/yfpy.models.Division.html @@ -4,9 +4,12 @@ - yfpy.models.Division — YFPY v7.0.0 documentation + yfpy.models.Division — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Division
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Division
division_id
-
+

The unique division ID number in the league.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.Division
name
-
+

The division name.

+
Type

str

@@ -162,8 +202,8 @@

yfpy.models.Division

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.Division

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.DivisionalOutcomeTotals.html b/docs/_autosummary/yfpy.models.DivisionalOutcomeTotals.html index 9497c3c1..0eff59b2 100644 --- a/docs/_autosummary/yfpy.models.DivisionalOutcomeTotals.html +++ b/docs/_autosummary/yfpy.models.DivisionalOutcomeTotals.html @@ -4,9 +4,12 @@ - yfpy.models.DivisionalOutcomeTotals — YFPY v7.0.0 documentation + yfpy.models.DivisionalOutcomeTotals — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.DivisionalOutcomeTotals
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.DivisionalOutcomeTotals
losses
-
+

The number of losses by the team within the division.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.DivisionalOutcomeTotals
ties
-
+

The number of ties by the team within the division.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.DivisionalOutcomeTotals
wins
-
+

The number of wins by the team within the division.

+
Type

int

@@ -172,8 +213,8 @@

yfpy.models.DivisionalOutcomeTotals

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.DivisionalOutcomeTotals +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.DraftAnalysis.html b/docs/_autosummary/yfpy.models.DraftAnalysis.html index 388ffe62..fabaab31 100644 --- a/docs/_autosummary/yfpy.models.DraftAnalysis.html +++ b/docs/_autosummary/yfpy.models.DraftAnalysis.html @@ -4,9 +4,12 @@ - yfpy.models.DraftAnalysis — YFPY v7.0.0 documentation + yfpy.models.DraftAnalysis — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.DraftAnalysis
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.DraftAnalysis
average_pick
-
+

The average pick at which the player was drafted.

+
Type

float

@@ -145,7 +184,8 @@

yfpy.models.DraftAnalysis
average_round
-
+

The average round in which the player was drafted.

+
Type

float

@@ -155,7 +195,8 @@

yfpy.models.DraftAnalysis
average_cost
-
+

The average price paid for the player to be drafted.

+
Type

float

@@ -165,7 +206,8 @@

yfpy.models.DraftAnalysis
percent_drafted
-
+

The overall percentage the player was drafted.

+
Type

float

@@ -182,8 +224,8 @@

yfpy.models.DraftAnalysis

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.DraftAnalysis +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.DraftResult.html b/docs/_autosummary/yfpy.models.DraftResult.html index b0cc54a0..3dc9183d 100644 --- a/docs/_autosummary/yfpy.models.DraftResult.html +++ b/docs/_autosummary/yfpy.models.DraftResult.html @@ -4,9 +4,12 @@ - yfpy.models.DraftResult — YFPY v7.0.0 documentation + yfpy.models.DraftResult — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.DraftResult
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.DraftResult
pick
-
+

The draft pick number.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.DraftResult
round
-
+

The draft round.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.DraftResult
team_key
-
+

The Yahoo team key of the team that made the draft pick.

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.DraftResult
player_key
-
+

The Yahoo player key of the player that was drafted.

+
Type

str

@@ -182,8 +224,8 @@

yfpy.models.DraftResult

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.DraftResult

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Game.html b/docs/_autosummary/yfpy.models.Game.html index bf497b78..581bc627 100644 --- a/docs/_autosummary/yfpy.models.Game.html +++ b/docs/_autosummary/yfpy.models.Game.html @@ -4,9 +4,12 @@ - yfpy.models.Game — YFPY v7.0.0 documentation + yfpy.models.Game — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Game
    • -
+
@@ -135,7 +173,7 @@

yfpy.models.Game
code
-

Yahoo Fantasy game code.

+

The Yahoo Fantasy game code.

Type

str

@@ -146,7 +184,7 @@

yfpy.models.Game
game_id
-

Yahoo Fantasy game ID.

+

The Yahoo Fantasy game ID.

Type

int

@@ -157,7 +195,7 @@

yfpy.models.Game
game_key
-

Yahoo Fantasy game key.

+

The Yahoo Fantasy game key.

Type

str

@@ -168,10 +206,10 @@

yfpy.models.Game
game_weeks
-

Yahoo Fantasy GameWeek objects.

+

A list of YFPY GameWeek instances.

Type
-

list of GameWeek

+

list[GameWeek]

@@ -179,7 +217,7 @@

yfpy.models.Game
is_game_over
-

Numeric boolean (0 or 1) representing if the Yahoo Fantasy Game is complete.

+

Numeric boolean (0 or 1) representing if the Yahoo Fantasy game is complete.

Type

int

@@ -223,10 +261,10 @@

yfpy.models.Game
leagues
-

Yahoo Fantasy League objects.

+

A list of YFPY League instances.

Type
-

list of League

+

list[League]

@@ -234,7 +272,7 @@

yfpy.models.Game
name
-

Yahoo Fantasy game name.

+

The name of the Yahoo Fantasy game.

Type

str

@@ -245,10 +283,10 @@

yfpy.models.Game
position_types
-

Yahoo Fantasy PositionType objects.

+

A list of YFPY PositionType instances.

Type
-

list of PositionType

+

list[PositionType]

@@ -256,10 +294,10 @@

yfpy.models.Game
roster_positions
-

Yahoo Fantasy RosterPosition objects.

+

A list of YFPY RosterPosition instances.

Type
-

list of RosterPosition

+

list[RosterPosition]

@@ -267,7 +305,7 @@

yfpy.models.Game
season
-

Yahoo Fantasy game year.

+

The Yahoo Fantasy game year.

Type

int

@@ -278,7 +316,7 @@

yfpy.models.Game
stat_categories
-

Yahoo Fantasy StatCategories object.

+

A YFPY StatCategories instance.

Type

StatCategories

@@ -289,10 +327,10 @@

yfpy.models.Game
teams
-

Yahoo Fantasy Team objects.

+

A list of YFPY Team instances.

Type
-

list of Team

+

list[Team]

@@ -300,7 +338,7 @@

yfpy.models.Game
type
-

Yahoo Fantasy game type.

+

The type of the Yahoo Fantasy game.

Type

str

@@ -311,7 +349,7 @@

yfpy.models.Game
url
-

Yahoo Fantasy game URL.

+

The direct URL of the Yahoo Fantasy game.

Type

str

@@ -329,8 +367,8 @@

yfpy.models.Game

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -357,6 +395,20 @@

yfpy.models.Game +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.GameWeek.html b/docs/_autosummary/yfpy.models.GameWeek.html index 641eff26..c1e4d5fd 100644 --- a/docs/_autosummary/yfpy.models.GameWeek.html +++ b/docs/_autosummary/yfpy.models.GameWeek.html @@ -4,9 +4,12 @@ - yfpy.models.GameWeek — YFPY v7.0.0 documentation + yfpy.models.GameWeek — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.GameWeek
    • -
+
@@ -135,7 +173,7 @@

yfpy.models.GameWeek
display_name
-

Yahoo Fantasy GameWeek display name.

+

The display name of the Yahoo Fantasy game week.

Type

str

@@ -146,7 +184,7 @@

yfpy.models.GameWeek
end
-

Yahoo Fantasy GameWeek end date.

+

The end date of the Yahoo Fantasy game week.

Type

str

@@ -157,7 +195,7 @@

yfpy.models.GameWeek
start
-

Yahoo Fantasy GameWeek start date.

+

The start date of the Yahoo Fantasy game week.

Type

str

@@ -168,7 +206,7 @@

yfpy.models.GameWeek
week
-

Yahoo Fantasy GameWeek week number.

+

The week number of the Yahoo Fantasy game week.

Type

int

@@ -186,8 +224,8 @@

yfpy.models.GameWeek

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -214,6 +252,20 @@

yfpy.models.GameWeek

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Headshot.html b/docs/_autosummary/yfpy.models.Headshot.html index 1ce30d79..595f7520 100644 --- a/docs/_autosummary/yfpy.models.Headshot.html +++ b/docs/_autosummary/yfpy.models.Headshot.html @@ -4,9 +4,12 @@ - yfpy.models.Headshot — YFPY v7.0.0 documentation + yfpy.models.Headshot — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Headshot
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Headshot
size
-
+

The size of the headshot photo (“small”, “large”, etc.)

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Headshot
url
-
+

The direct URL of the headshot photo.

+
Type

str

@@ -162,8 +202,8 @@

yfpy.models.Headshot

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.Headshot

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.League.html b/docs/_autosummary/yfpy.models.League.html index 2043c080..f567fb4e 100644 --- a/docs/_autosummary/yfpy.models.League.html +++ b/docs/_autosummary/yfpy.models.League.html @@ -4,9 +4,12 @@ - yfpy.models.League — YFPY v7.0.0 documentation + yfpy.models.League — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.League
    • -
+
@@ -135,7 +173,9 @@

yfpy.models.League
allow_add_to_dl_extra_pos
-
+

Numeric boolean (0 or 1) representing if the leagues allows adding extra +positions to the DL (currently uncertain what this is).

+
Type

int

@@ -145,7 +185,8 @@

yfpy.models.League
current_week
-
+

The current week number.

+
Type

int

@@ -155,9 +196,10 @@

yfpy.models.League
draft_results
-
+

A list of YFPY DraftResult instances.

+
Type
-

str

+

list[DraftResult]

@@ -165,7 +207,8 @@

yfpy.models.League
draft_status
-
+

The status of the draft (“postdraft”, etc.).

+
Type

str

@@ -175,7 +218,8 @@

yfpy.models.League
display_name
-
+

The display name of the league.

+
Type

str

@@ -185,7 +229,8 @@

yfpy.models.League
edit_key
-
+

The Yahoo edit key for the league.

+
Type

int

@@ -195,7 +240,8 @@

yfpy.models.League
end_date
-
+

A date string representing the end date of the league (format: “YYYY-MM-DD”).

+
Type

str

@@ -205,7 +251,8 @@

yfpy.models.League
end_week
-
+

The number of the last week of the league.

+
Type

int

@@ -215,7 +262,8 @@

yfpy.models.League
entry_fee
-
+

The entry fee for Yahoo paid leagues (USD).

+
Type

str

@@ -225,7 +273,8 @@

yfpy.models.League
game_code
-
+

The Yahoo game code (“nfl”, “nhl”, “nba”, “mlb”).

+
Type

str

@@ -235,9 +284,10 @@

yfpy.models.League
iris_group_chat_id
-
+

The unique IRIS group chat ID for the league.

+
Type
-

str

+

str | null

@@ -245,7 +295,8 @@

yfpy.models.League
is_cash_league
-
+

Numeric boolean (0 or 1) representing if the league is a Yahoo paid league.

+
Type

int

@@ -255,7 +306,8 @@

yfpy.models.League
is_finished
-
+

Numeric boolean (0 or 1) representing if the league season has completed.

+
Type

int

@@ -265,7 +317,8 @@

yfpy.models.League
is_pro_league
-
+

Numeric boolean (0 or 1) representing if the league is a Yahoo Pro league.

+
Type

str

@@ -275,7 +328,8 @@

yfpy.models.League
league_id
-
+

The unique Yahoo league ID.

+
Type

str

@@ -285,7 +339,8 @@

yfpy.models.League
league_key
-
+

The Yahoo league key.

+
Type

str

@@ -295,7 +350,8 @@

yfpy.models.League
league_type
-
+

The type of the league (“private”, “public”).

+
Type

str

@@ -305,7 +361,8 @@

yfpy.models.League
league_update_timestamp
-
+

A timestamp representing the last time the league was updated.

+
Type

int

@@ -315,7 +372,8 @@

yfpy.models.League
logo_url
-
+

The direct URL of the league logo photo.

+
Type

str

@@ -325,7 +383,8 @@

yfpy.models.League
name
-
+

The name of the league.

+
Type

str

@@ -335,7 +394,8 @@

yfpy.models.League
num_teams
-
+

The number of teams in the league.

+
Type

str

@@ -345,9 +405,10 @@

yfpy.models.League
password
-
+

The password required to join the league (if applicable).

+
Type
-

str

+

str | null

@@ -355,7 +416,9 @@

yfpy.models.League
payment_deadline
-
+

A date string representing the deadline by which all league dues payments must be +made (format: “YYYY-MM-DD”).

+
Type

str

@@ -365,9 +428,10 @@

yfpy.models.League
players
-
+

A list of YFPY Player instances.

+
Type
-

str

+

list[Player]

@@ -375,9 +439,11 @@

yfpy.models.League
renew
-
+

A string indicating the previous Yahoo game code and previous Yahoo league ID (Ex.: +“371_811308”) (if applicable).

+
Type
-

str

+

str | null

@@ -385,9 +451,11 @@

yfpy.models.League
renewed
-
+

A string indicating the next Yahoo game code and next Yahoo league ID (Ex.: +“390_303233”) (if applicable).

+
Type
-

str

+

str | null

@@ -395,7 +463,8 @@

yfpy.models.League
scoreboard
-
+

A YFPY Scoreboard instance.

+
Type

Scoreboard

@@ -405,9 +474,10 @@

yfpy.models.League
matchups
-
+

A list of YFPY Matchup instances.

+
Type
-

list of Matchup

+

list[Matchup]

@@ -415,7 +485,8 @@

yfpy.models.League
scoring_type
-
+

The scoring type of the league (“head” for head-to-head, etc.).

+
Type

str

@@ -425,7 +496,8 @@

yfpy.models.League
season
-
+

The season year of the league.

+
Type

int

@@ -435,7 +507,8 @@

yfpy.models.League
settings
-
+

A YFPY Settings instance.

+
Type

Settings

@@ -445,7 +518,8 @@

yfpy.models.League
short_invitation_url
-
+

The sharable short URL sent by invite allowing players to join the league.

+
Type

str

@@ -455,7 +529,8 @@

yfpy.models.League
standings
-
+

A YFPY Standings instance.

+
Type

Standings

@@ -465,9 +540,11 @@

yfpy.models.League
teams_ordered_by_standings
-
+

A list of YFPY Team instances ordered by their ranks in the league +standings.

+
Type
-

list of Team

+

list[Team]

@@ -475,7 +552,8 @@

yfpy.models.League
start_date
-
+

A date string representing the start date of the league (format: “YYYY-MM-DD”).

+
Type

str

@@ -485,7 +563,8 @@

yfpy.models.League
start_week
-
+

The number of the first week of the league.

+
Type

int

@@ -495,9 +574,10 @@

yfpy.models.League
transactions
-
+

A list of YFPY Transaction instances.

+
Type
-

list of Transaction

+

list[Transaction]

@@ -505,7 +585,8 @@

yfpy.models.League
url
-
+

The direct URL of the league.

+
Type

str

@@ -515,9 +596,10 @@

yfpy.models.League
weekly_deadline
-
+

The weekly deadline of the league (if applicable).

+
Type
-

str

+

str | null

@@ -532,8 +614,8 @@

yfpy.models.League

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -560,6 +642,20 @@

yfpy.models.League +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Manager.html b/docs/_autosummary/yfpy.models.Manager.html index 8fb5109b..82452516 100644 --- a/docs/_autosummary/yfpy.models.Manager.html +++ b/docs/_autosummary/yfpy.models.Manager.html @@ -4,9 +4,12 @@ - yfpy.models.Manager — YFPY v7.0.0 documentation + yfpy.models.Manager — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Manager
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Manager
email
-
+

The email address of the manager.

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Manager
guid
-
+

The unique Yahoo GUID of the user account associated with manager.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Manager
image_url
-
+

The direct URL of the manager profile image.

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.Manager
is_comanager
-
+

Numeric boolean (0 or 1) representing if the manager is a co-manager.

+
Type

int

@@ -175,7 +217,8 @@

yfpy.models.Manager
manager_id
-
+

The unique manager ID in the league.

+
Type

int

@@ -185,7 +228,8 @@

yfpy.models.Manager
nickname
-
+

The display nickname of the manager.

+
Type

str

@@ -202,8 +246,8 @@

yfpy.models.Manager

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -230,6 +274,20 @@

yfpy.models.Manager +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Matchup.html b/docs/_autosummary/yfpy.models.Matchup.html index c2f861fe..94a991d3 100644 --- a/docs/_autosummary/yfpy.models.Matchup.html +++ b/docs/_autosummary/yfpy.models.Matchup.html @@ -4,9 +4,12 @@ - yfpy.models.Matchup — YFPY v7.0.0 documentation + yfpy.models.Matchup — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Matchup
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Matchup
is_consolation
-
+

Numeric boolean (0 or 1) representing if the matchup is in a consolation bracket.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.Matchup
is_matchup_recap_available
-
+

Numeric boolean (0 or 1) representing if the matchup recap is available.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.Matchup
is_playoffs
-
+

Numeric boolean (0 or 1) representing if the matchup is in the playoffs bracket.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.Matchup
is_tied
-
+

Numeric boolean (0 or 1) representing if the matchup result is tied.

+
Type

int

@@ -175,9 +217,10 @@

yfpy.models.Matchup
matchup_grades
-
+

A list of YFPY MatchupGrade instances.

+
Type
-

list of MatchupGrade

+

list[MatchupGrade]

@@ -185,7 +228,8 @@

yfpy.models.Matchup
matchup_recap_title
-
+

The title of the matchup recap.

+
Type

str

@@ -195,7 +239,8 @@

yfpy.models.Matchup
matchup_recap_url
-
+

The direct URL of the matchup recap.

+
Type

str

@@ -205,7 +250,8 @@

yfpy.models.Matchup
status
-
+

The status of the matchup (“postevent”, etc.).

+
Type

str

@@ -215,9 +261,10 @@

yfpy.models.Matchup
teams
-
+

A list of YFPY Team instances for teams in the matchup.

+
Type
-

list of Team

+

list[Team]

@@ -225,7 +272,8 @@

yfpy.models.Matchup
week
-
+

The week number of the matchup.

+
Type

int

@@ -235,7 +283,8 @@

yfpy.models.Matchup
week_end
-
+

A date string representing the end of the matchup week (format: “YYYY-MM-DD”).

+
Type

str

@@ -245,7 +294,8 @@

yfpy.models.Matchup
week_start
-
+

A date string representing the start of the matchup week (format: “YYYY-MM-DD”).

+
Type

str

@@ -255,7 +305,8 @@

yfpy.models.Matchup
winner_team_key
-
+

The Yahoo team key of the team that won the matchup.

+
Type

str

@@ -272,8 +323,8 @@

yfpy.models.Matchup

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -300,6 +351,20 @@

yfpy.models.Matchup +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.MatchupGrade.html b/docs/_autosummary/yfpy.models.MatchupGrade.html index 30f5d526..611aa7d5 100644 --- a/docs/_autosummary/yfpy.models.MatchupGrade.html +++ b/docs/_autosummary/yfpy.models.MatchupGrade.html @@ -4,9 +4,12 @@ - yfpy.models.MatchupGrade — YFPY v7.0.0 documentation + yfpy.models.MatchupGrade — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.MatchupGrade
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.MatchupGrade
grade
-
+

The letter grade assigned to the matchup performance (“A+”, “A”, …, “F-“).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.MatchupGrade
team_key
-
+

The Yahoo team key for the team receiving the matchup grade.

+
Type

str

@@ -162,8 +202,8 @@

yfpy.models.MatchupGrade

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.MatchupGrade +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Name.html b/docs/_autosummary/yfpy.models.Name.html index 8fa7d435..0dba9804 100644 --- a/docs/_autosummary/yfpy.models.Name.html +++ b/docs/_autosummary/yfpy.models.Name.html @@ -4,9 +4,12 @@ - yfpy.models.Name — YFPY v7.0.0 documentation + yfpy.models.Name — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Name
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Name
ascii_first
-
+

The ASCII encoded string of the first name of the player.

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Name
ascii_last
-
+

The ASCII encoded string of the last name of the player.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Name
first
-
+

The first name of the player.

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.Name
full
-
+

The full name of the player.

+
Type

str

@@ -175,7 +217,8 @@

yfpy.models.Name
last
-
+

The last name of teh player.

+
Type

str

@@ -192,8 +235,8 @@

yfpy.models.Name

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -220,6 +263,20 @@

yfpy.models.Name +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.OutcomeTotals.html b/docs/_autosummary/yfpy.models.OutcomeTotals.html index 68f40a18..5d6bfc3a 100644 --- a/docs/_autosummary/yfpy.models.OutcomeTotals.html +++ b/docs/_autosummary/yfpy.models.OutcomeTotals.html @@ -4,9 +4,12 @@ - yfpy.models.OutcomeTotals — YFPY v7.0.0 documentation + yfpy.models.OutcomeTotals — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.OutcomeTotals
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.OutcomeTotals
losses
-
+

The number of losses by the team.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.OutcomeTotals
percentage
-
+

The win percentage of the team.

+
Type

float

@@ -155,7 +195,8 @@

yfpy.models.OutcomeTotals
ties
-
+

The number of ties by the team.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.OutcomeTotals
wins
-
+

The number of wins by the team.

+
Type

int

@@ -182,8 +224,8 @@

yfpy.models.OutcomeTotals

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.OutcomeTotals +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Ownership.html b/docs/_autosummary/yfpy.models.Ownership.html index 896d17e3..ec858569 100644 --- a/docs/_autosummary/yfpy.models.Ownership.html +++ b/docs/_autosummary/yfpy.models.Ownership.html @@ -4,9 +4,12 @@ - yfpy.models.Ownership — YFPY v7.0.0 documentation + yfpy.models.Ownership — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Ownership
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Ownership
ownership_type
-
+

The current location of the player in the league (“team”, “waivers”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Ownership
owner_team_key
-
+

The Yahoo team key for the team that owns the player.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Ownership
owner_team_name
-
+

The team name for the team that owns the player.

+
Type

str

@@ -165,9 +206,10 @@

yfpy.models.Ownership
teams
-
+

A list of YFPY Team instances.

+
Type
-

list of Team

+

list[Team]

@@ -182,8 +224,8 @@

yfpy.models.Ownership

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.Ownership

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.PercentOwned.html b/docs/_autosummary/yfpy.models.PercentOwned.html index 1308f73c..f693f783 100644 --- a/docs/_autosummary/yfpy.models.PercentOwned.html +++ b/docs/_autosummary/yfpy.models.PercentOwned.html @@ -4,9 +4,12 @@ - yfpy.models.PercentOwned — YFPY v7.0.0 documentation + yfpy.models.PercentOwned — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.PercentOwned
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.PercentOwned
coverage_type
-
+

The timeframe for the selected player ownership (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.PercentOwned
week
-
+

The week number (when applicable).

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.PercentOwned
value
-
+

The percentage value the player is/was owned in the coverage timeframe.

+
Type

int

@@ -165,7 +206,9 @@

yfpy.models.PercentOwned
delta
-
+

The change in the percentage value from the previous coverage timeframe to the current +coverage timeframe.

+
Type

float

@@ -182,8 +225,8 @@

yfpy.models.PercentOwned

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +253,20 @@

yfpy.models.PercentOwned +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Player.html b/docs/_autosummary/yfpy.models.Player.html index 968ec67d..45205b93 100644 --- a/docs/_autosummary/yfpy.models.Player.html +++ b/docs/_autosummary/yfpy.models.Player.html @@ -4,9 +4,12 @@ - yfpy.models.Player — YFPY v7.0.0 documentation + yfpy.models.Player — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Player
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Player
bye_weeks
-
+

A YFPY ByeWeeks instance.

+
Type

ByeWeeks

@@ -145,7 +184,8 @@

yfpy.models.Player
bye
-
+

The week number that the player is on bye.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.Player
display_position
-
+

The display string for the player position.

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.Player
draft_analysis
-
+

A YFPY DraftAnalysis instance.

+
Type

DraftAnalysis

@@ -175,7 +217,8 @@

yfpy.models.Player
average_draft_pick
-
+

The average pick at which the player was drafted.

+
Type

float

@@ -185,7 +228,8 @@

yfpy.models.Player
average_draft_round
-
+

The average round in which the player was drafted.

+
Type

float

@@ -195,7 +239,8 @@

yfpy.models.Player
average_draft_cost
-
+

The average price paid for the player to be drafted.

+
Type

float

@@ -205,7 +250,8 @@

yfpy.models.Player
percent_drafted
-
+

The overall percentage the player was drafted.

+
Type

float

@@ -215,7 +261,8 @@

yfpy.models.Player
editorial_player_key
-
+

The Yahoo player key using the game key.

+
Type

str

@@ -225,7 +272,8 @@

yfpy.models.Player
editorial_team_abbr
-
+

The abbreviation of the professional team name for which the player plays.

+
Type

str

@@ -235,7 +283,8 @@

yfpy.models.Player
editorial_team_full_name
-
+

The name of the professional team for which the player plays.

+
Type

str

@@ -245,7 +294,8 @@

yfpy.models.Player
editorial_team_key
-
+

The Yahoo team key using the game key.

+
Type

str

@@ -255,9 +305,10 @@

yfpy.models.Player
eligible_positions
-
+

A list of positions for which the player is eligible.

+
Type
-

list of str

+

list[str]

@@ -265,7 +316,8 @@

yfpy.models.Player
has_player_notes
-
+

Numeric boolean (0 or 1) representing if the player has any notes.

+
Type

int

@@ -275,7 +327,8 @@

yfpy.models.Player
headshot
-
+

A YFPY Headshot instance.

+
Type

Headshot

@@ -285,7 +338,8 @@

yfpy.models.Player
headshot_size
-
+

The headshot photo size (“small”, “large”, etc.)

+
Type

str

@@ -295,7 +349,8 @@

yfpy.models.Player
headshot_url
-
+

The direct URL of the headshot photo.

+
Type

str

@@ -305,7 +360,8 @@

yfpy.models.Player
is_editable
-
+

Numeric boolean (0 or 1) representing if the player is editable.

+
Type

int

@@ -315,7 +371,8 @@

yfpy.models.Player
is_undroppable
-
+

Numeric boolean (0 or 1) representing if the player is undroppable.

+
Type

int

@@ -325,7 +382,8 @@

yfpy.models.Player
name
-
+

A YFPY Name instance.

+
Type

Name

@@ -335,7 +393,8 @@

yfpy.models.Player
first_name
-
+

The first name of the player.

+
Type

str

@@ -345,7 +404,8 @@

yfpy.models.Player
last_name
-
+

The last name of the player.

+
Type

str

@@ -355,7 +415,8 @@

yfpy.models.Player
full_name
-
+

The full name of the player.

+
Type

str

@@ -365,7 +426,8 @@

yfpy.models.Player
ownership
-
+

A YFPY Ownership instance.

+
Type

Ownership

@@ -375,7 +437,8 @@

yfpy.models.Player
percent_owned
-
+

A YFPY PercentOwned instanced.

+
Type

PercentOwned

@@ -385,7 +448,8 @@

yfpy.models.Player
percent_owned_value
-
+

The percentage value the player is/was owned in the coverage timeframe.

+
Type

float

@@ -395,7 +459,8 @@

yfpy.models.Player
player_id
-
+

The unique player ID.

+
Type

int

@@ -405,7 +470,8 @@

yfpy.models.Player
player_key
-
+

The Yahoo player key.

+
Type

str

@@ -415,7 +481,8 @@

yfpy.models.Player
player_notes_last_timestamp
-
+

A timestamp of the most recent players notes.

+
Type

int

@@ -425,7 +492,8 @@

yfpy.models.Player
player_points
-
+

A YFPY PlayerPoints instance.

+
Type

PlayerPoints

@@ -435,7 +503,8 @@

yfpy.models.Player
player_points_value
-
+

The total points for the player within the coverage timeframe.

+
Type

float

@@ -445,7 +514,8 @@

yfpy.models.Player
player_stats
-
+

A YFPY PlayerStats instance.

+
Type

PlayerStats

@@ -455,9 +525,10 @@

yfpy.models.Player
stats
-
+

A list of YFPY Stat instances.

+
Type
-

list of Stat

+

list[Stat]

@@ -465,7 +536,8 @@

yfpy.models.Player
position_type
-
+

The position type of the player (“offense”, “defense”, etc.).

+
Type

str

@@ -475,7 +547,8 @@

yfpy.models.Player
primary_position
-
+

The primary position of the player.

+
Type

str

@@ -485,7 +558,8 @@

yfpy.models.Player
selected_position
-
+

A YFPY SelectedPosition instance.

+
Type

SelectedPosition

@@ -495,7 +569,8 @@

yfpy.models.Player
selected_position_value
-
+

The selected position of the player.

+
Type

str

@@ -505,7 +580,8 @@

yfpy.models.Player
status
-
+

The status of the player (“IR”, “PUP”, “O”, “Q”, etc.).

+
Type

str

@@ -515,7 +591,8 @@

yfpy.models.Player
transaction_data
-
+

A YFPY TransactionData instance.

+
Type

TransactionData

@@ -525,7 +602,8 @@

yfpy.models.Player
uniform_number
-
+

The uniform number of the player.

+
Type

int

@@ -542,8 +620,8 @@

yfpy.models.Player

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -570,6 +648,20 @@

yfpy.models.Player +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.PlayerPoints.html b/docs/_autosummary/yfpy.models.PlayerPoints.html index 64248b99..6e4754aa 100644 --- a/docs/_autosummary/yfpy.models.PlayerPoints.html +++ b/docs/_autosummary/yfpy.models.PlayerPoints.html @@ -4,9 +4,12 @@ - yfpy.models.PlayerPoints — YFPY v7.0.0 documentation + yfpy.models.PlayerPoints — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.PlayerPoints
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.PlayerPoints
coverage_type
-
+

The timeframe for the selected player points (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.PlayerPoints
week
-
+

The week number (when applicable).

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.PlayerPoints
total
-
+

The total points for the player within the coverage timeframe.

+
Type

float

@@ -172,8 +213,8 @@

yfpy.models.PlayerPoints

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.PlayerPoints +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.PlayerStats.html b/docs/_autosummary/yfpy.models.PlayerStats.html index 98450d96..a675b4f3 100644 --- a/docs/_autosummary/yfpy.models.PlayerStats.html +++ b/docs/_autosummary/yfpy.models.PlayerStats.html @@ -4,9 +4,12 @@ - yfpy.models.PlayerStats — YFPY v7.0.0 documentation + yfpy.models.PlayerStats — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.PlayerStats
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.PlayerStats
coverage_type
-
+

The timeframe for the selected player stats (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.PlayerStats
week
-
+

The week number (when applicable).

+
Type

int

@@ -155,9 +195,10 @@

yfpy.models.PlayerStats
stats
-
+

A list of YFPY Stat instances for the player.

+
Type
-

list of Stat

+

list[Stat]

@@ -172,8 +213,8 @@

yfpy.models.PlayerStats

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.PlayerStats

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.PositionType.html b/docs/_autosummary/yfpy.models.PositionType.html index 8a600e9b..269b0824 100644 --- a/docs/_autosummary/yfpy.models.PositionType.html +++ b/docs/_autosummary/yfpy.models.PositionType.html @@ -4,9 +4,12 @@ - yfpy.models.PositionType — YFPY v7.0.0 documentation + yfpy.models.PositionType — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.PositionType
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.PositionType
type
-
+

The type of the player position (“offense”, “defense”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.PositionType
display_name
-
+

The full text display of the position type.

+
Type

str

@@ -162,8 +202,8 @@

yfpy.models.PositionType

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.PositionType +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Roster.html b/docs/_autosummary/yfpy.models.Roster.html index 18bd6593..982bf795 100644 --- a/docs/_autosummary/yfpy.models.Roster.html +++ b/docs/_autosummary/yfpy.models.Roster.html @@ -4,9 +4,12 @@ - yfpy.models.Roster — YFPY v7.0.0 documentation + yfpy.models.Roster — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Roster
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Roster
coverage_type
-
+

The timeframe for the selected roster (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Roster
week
-
+

The week number.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.Roster
is_editable
-
+

Numeric boolean (0 or 1) representing if the roster is editable.

+
Type

int

@@ -165,9 +206,10 @@

yfpy.models.Roster
players
-
+

A list of YFPY Player instances.

+
Type
-

list of Player

+

list[Player]

@@ -182,8 +224,8 @@

yfpy.models.Roster

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.Roster +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.RosterAdds.html b/docs/_autosummary/yfpy.models.RosterAdds.html index 058054ad..87eecd83 100644 --- a/docs/_autosummary/yfpy.models.RosterAdds.html +++ b/docs/_autosummary/yfpy.models.RosterAdds.html @@ -4,9 +4,12 @@ - yfpy.models.RosterAdds — YFPY v7.0.0 documentation + yfpy.models.RosterAdds — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.RosterAdds
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.RosterAdds
coverage_type
-
+

The timeframe for the selected roster (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.RosterAdds
coverage_value
-
+

The value of the coverage type (week number, for instance).

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.RosterAdds
value
-
+

The number of roster adds within the coverage timeframe.

+
Type

int

@@ -172,8 +213,8 @@

yfpy.models.RosterAdds

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.RosterAdds

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.RosterPosition.html b/docs/_autosummary/yfpy.models.RosterPosition.html index 59e941f5..b2158a58 100644 --- a/docs/_autosummary/yfpy.models.RosterPosition.html +++ b/docs/_autosummary/yfpy.models.RosterPosition.html @@ -4,9 +4,12 @@ - yfpy.models.RosterPosition — YFPY v7.0.0 documentation + yfpy.models.RosterPosition — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.RosterPosition
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.RosterPosition
count
-
+

The number of roster slots available for this position.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.RosterPosition
position
-
+

The position string.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.RosterPosition
position_type
-
+

The position type (“O” for offense, etc.)

+
Type

str

@@ -172,8 +213,8 @@

yfpy.models.RosterPosition

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.RosterPosition +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Scoreboard.html b/docs/_autosummary/yfpy.models.Scoreboard.html index c9a93af8..19a43589 100644 --- a/docs/_autosummary/yfpy.models.Scoreboard.html +++ b/docs/_autosummary/yfpy.models.Scoreboard.html @@ -4,9 +4,12 @@ - yfpy.models.Scoreboard — YFPY v7.0.0 documentation + yfpy.models.Scoreboard — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Scoreboard
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Scoreboard
week
-
+

The week for which the scoreboard applies.

+
Type

int

@@ -145,9 +184,10 @@

yfpy.models.Scoreboard
matchups
-
+

A list of YFPY Matchup instances representing the matchups for the week.

+
Type
-

list of Matchup

+

list[Matchup]

@@ -162,8 +202,8 @@

yfpy.models.Scoreboard

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.Scoreboard

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.SelectedPosition.html b/docs/_autosummary/yfpy.models.SelectedPosition.html index 28928072..ee7c8ad6 100644 --- a/docs/_autosummary/yfpy.models.SelectedPosition.html +++ b/docs/_autosummary/yfpy.models.SelectedPosition.html @@ -4,9 +4,12 @@ - yfpy.models.SelectedPosition — YFPY v7.0.0 documentation + yfpy.models.SelectedPosition — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.SelectedPosition
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.SelectedPosition
coverage_type
-
+

The timeframe for the selected position (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.SelectedPosition
is_flex
-
+

Numeric boolean (0 or 1) representing if the selected player is in a flex roster slot.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.SelectedPosition
position
-
+

The selected position of the player.

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.SelectedPosition
week
-
+

The week number (when applicable).

+
Type

int

@@ -182,8 +224,8 @@

yfpy.models.SelectedPosition

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.SelectedPosition +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Settings.html b/docs/_autosummary/yfpy.models.Settings.html index e8be00dd..3562665e 100644 --- a/docs/_autosummary/yfpy.models.Settings.html +++ b/docs/_autosummary/yfpy.models.Settings.html @@ -4,9 +4,12 @@ - yfpy.models.Settings — YFPY v7.0.0 documentation + yfpy.models.Settings — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Settings
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Settings
cant_cut_list
-
+

Numeric boolean (0 or 1) representing if the league uses the Yahoo “can’t cut list”.

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Settings
divisions
-
+

Numeric boolean (0 or 1) representing if the league has divisions.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.Settings
draft_pick_time
-
+

The number of seconds allowed to make each draft pick.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.Settings
draft_time
-
+

A timestamp representing when the draft will start.

+
Type

int

@@ -175,7 +217,8 @@

yfpy.models.Settings
draft_type
-
+

The type of draft (“live”, “offline”, etc.)

+
Type

str

@@ -185,7 +228,9 @@

yfpy.models.Settings
has_multiweek_championship
-
+

Numeric boolean (0 or 1) representing if the league has a multi-week +championship matchup.

+
Type

int

@@ -195,7 +240,9 @@

yfpy.models.Settings
has_playoff_consolation_games
-
+

Numeric boolean (0 or 1) representing if the league has a consolation +playoff bracket.

+
Type

bool

@@ -205,7 +252,8 @@

yfpy.models.Settings
is_auction_draft
-
+

Numeric boolean (0 or 1) representing if the league uses an auction draft.

+
Type

int

@@ -215,7 +263,8 @@

yfpy.models.Settings
max_teams
-
+

The maximum number of teams allowed in the league.

+
Type

int

@@ -223,9 +272,10 @@

yfpy.models.Settings

-
-num_playoff_consolation_games
-
+
+num_playoff_consolation_teams
+

The number of teams that make the consolation playoff bracket.

+
Type

int

@@ -235,7 +285,8 @@

yfpy.models.Settings
num_playoff_teams
-
+

The number of teams that make the playoffs.

+
Type

int

@@ -245,7 +296,9 @@

yfpy.models.Settings
pickem_enabled
-
+

Numeric boolean (0 or 1) representing if the league has enabled the built-in Yahoo +“pick ‘em” game that allows managers to pick winners of each fantasy matchup each week in the league.

+
Type

int

@@ -255,7 +308,8 @@

yfpy.models.Settings
player_pool
-
+

Value designating what player pool is allowed for the league (“ALL”, etc.).

+
Type

str

@@ -265,7 +319,8 @@

yfpy.models.Settings
playoff_start_week
-
+

The week number on which the playoffs start.

+
Type

int

@@ -275,7 +330,8 @@

yfpy.models.Settings
post_draft_players
-
+

Value designating what happens to players after the draft (“W” for waivers, etc.).

+
Type

str

@@ -285,9 +341,10 @@

yfpy.models.Settings
roster_positions
-
+

A list of YFPY RosterPosition instances.

+
Type
-

list of RosterPosition

+

list[RosterPosition]

@@ -295,7 +352,8 @@

yfpy.models.Settings
scoring_type
-
+

Value designating what type of scoring the league uses (“head” for head-to-head, etc.).

+
Type

str

@@ -305,7 +363,8 @@

yfpy.models.Settings
stat_categories
-
+

A YFPY StatCategories instance.

+
Type

StatCategories

@@ -315,7 +374,8 @@

yfpy.models.Settings
stat_modifiers
-
+

A YFPY StatModifiers instance.

+
Type

StatModifiers

@@ -325,7 +385,8 @@

yfpy.models.Settings
trade_end_date
-
+

A date string representing when trading is no longer allowed (format: “YYYY-MM-DD”).

+
Type

str

@@ -335,7 +396,8 @@

yfpy.models.Settings
trade_ratify_type
-
+

Value designating how trades are ratified (“commish” for commissioner, etc.).

+
Type

str

@@ -345,7 +407,8 @@

yfpy.models.Settings
trade_reject_time
-
+

The number of days during which a trade can be rejected.

+
Type

int

@@ -355,7 +418,9 @@

yfpy.models.Settings
uses_faab
-
+

Numeric boolean (0 or 1) representing if the league uses FAAB (Free Agent Acquisition +Budget).

+
Type

int

@@ -365,7 +430,8 @@

yfpy.models.Settings
uses_fractional_points
-
+

Numeric boolean (0 or 1) representing if the league allows fractional scoring.

+
Type

int

@@ -375,7 +441,9 @@

yfpy.models.Settings
uses_lock_eliminated_teams
-
+

Numeric boolean (0 or 1) representing if the league locks teams +eliminated from the playoffs.

+
Type

int

@@ -385,7 +453,8 @@

yfpy.models.Settings
uses_negative_points
-
+

Numeric boolean (0 or 1) representing if the league allows negative scoring.

+
Type

int

@@ -395,7 +464,8 @@

yfpy.models.Settings
uses_playoffs
-
+

Numeric boolean (0 or 1) representing if the league has playoffs.

+
Type

int

@@ -405,7 +475,9 @@

yfpy.models.Settings
uses_playoff_reseeding
-
+

Numeric boolean (0 or 1) representing if the league reseeds the playoffs once +the fantasy regular season is complete.

+
Type

int

@@ -415,7 +487,8 @@

yfpy.models.Settings
waiver_rule
-
+

Value designating when players go to waivers (“gametime”, etc.).

+
Type

str

@@ -425,7 +498,8 @@

yfpy.models.Settings
waiver_time
-
+

The number of days that players remain on waivers.

+
Type

int

@@ -435,7 +509,8 @@

yfpy.models.Settings
waiver_type
-
+

Value designating what type of waivers are used by the league (“R” for rolling, etc.).

+
Type

str

@@ -452,8 +527,8 @@

yfpy.models.Settings

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -480,6 +555,20 @@

yfpy.models.Settings

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Standings.html b/docs/_autosummary/yfpy.models.Standings.html index 7819d5ff..b403e986 100644 --- a/docs/_autosummary/yfpy.models.Standings.html +++ b/docs/_autosummary/yfpy.models.Standings.html @@ -4,9 +4,12 @@ - yfpy.models.Standings — YFPY v7.0.0 documentation + yfpy.models.Standings — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Standings
    • -
+
@@ -135,9 +173,10 @@

yfpy.models.Standings
teams
-
+

A list of YFPY Team instances with standings data.

+
Type
-

list of Team

+

list[Team]

@@ -152,8 +191,8 @@

yfpy.models.Standings

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -180,6 +219,20 @@

yfpy.models.Standings

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Stat.html b/docs/_autosummary/yfpy.models.Stat.html index adf4493d..86791d23 100644 --- a/docs/_autosummary/yfpy.models.Stat.html +++ b/docs/_autosummary/yfpy.models.Stat.html @@ -4,9 +4,12 @@ - yfpy.models.Stat — YFPY v7.0.0 documentation + yfpy.models.Stat — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Stat
    • -
+
@@ -135,9 +173,10 @@

yfpy.models.Stat
bonuses
-
+

A list of YFPY Bonus instances available for this stat category.

+
Type
-

list of Bonus

+

list[Bonus]

@@ -145,7 +184,8 @@

yfpy.models.Stat
display_name
-
+

The abbreviated display name of the stat.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Stat
enabled
-
+

Numeric boolean (0 or 1) representing if this stat is enabled for league scoring.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.Stat
name
-
+

The full name of the stat.

+
Type

str

@@ -175,7 +217,8 @@

yfpy.models.Stat
position_type
-
+

The player position type eligible for the stat.

+
Type

str

@@ -185,7 +228,9 @@

yfpy.models.Stat
sort_order
-
+

Numeric boolean (0 or 1) representing if the stat is sorted highest to lowest (1) or +lowest to highest (0).

+
Type

int

@@ -195,7 +240,8 @@

yfpy.models.Stat
stat_id
-
+

The unique stat ID number in the league.

+
Type

int

@@ -205,9 +251,10 @@

yfpy.models.Stat
stat_position_types
-
+

A list of YFPY PositionType instances.

+
Type
-

list of PositionType

+

list[PositionType]

@@ -215,7 +262,8 @@

yfpy.models.Stat
value
-
+

The value of the stat (if applicable).

+
Type

float

@@ -232,8 +280,8 @@

yfpy.models.Stat

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -260,6 +308,20 @@

yfpy.models.Stat +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.StatCategories.html b/docs/_autosummary/yfpy.models.StatCategories.html index f52e0375..c6e0258f 100644 --- a/docs/_autosummary/yfpy.models.StatCategories.html +++ b/docs/_autosummary/yfpy.models.StatCategories.html @@ -4,9 +4,12 @@ - yfpy.models.StatCategories — YFPY v7.0.0 documentation + yfpy.models.StatCategories — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.StatCategories
    • -
+
@@ -135,9 +173,10 @@

yfpy.models.StatCategories
stats
-
+

A list of YFPY Stat instances representing the league stat categories.

+
Type
-

list of Stat

+

list[Stat]

@@ -152,8 +191,8 @@

yfpy.models.StatCategories

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -180,6 +219,20 @@

yfpy.models.StatCategories +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.StatModifiers.html b/docs/_autosummary/yfpy.models.StatModifiers.html index 9c091442..6dc36823 100644 --- a/docs/_autosummary/yfpy.models.StatModifiers.html +++ b/docs/_autosummary/yfpy.models.StatModifiers.html @@ -4,9 +4,12 @@ - yfpy.models.StatModifiers — YFPY v7.0.0 documentation + yfpy.models.StatModifiers — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.StatModifiers
    • -
+
@@ -135,9 +173,10 @@

yfpy.models.StatModifiers
stats
-
+

A list of YFPY Stat instances containing modifiers for each stat category.

+
Type
-

list of Stat

+

list[Stat]

@@ -152,8 +191,8 @@

yfpy.models.StatModifiers

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -180,6 +219,20 @@

yfpy.models.StatModifiers +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.StatPositionType.html b/docs/_autosummary/yfpy.models.StatPositionType.html index dd410f46..7c8e55ec 100644 --- a/docs/_autosummary/yfpy.models.StatPositionType.html +++ b/docs/_autosummary/yfpy.models.StatPositionType.html @@ -4,9 +4,12 @@ - yfpy.models.StatPositionType — YFPY v7.0.0 documentation + yfpy.models.StatPositionType — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.StatPositionType
    • -
+
@@ -135,7 +173,9 @@

yfpy.models.StatPositionType
is_only_display_stat
-
+

Numeric boolean (0 or 1) representing if the stat is only for display (such as +if it is just the player position string).

+
Type

int

@@ -145,7 +185,8 @@

yfpy.models.StatPositionType
position_type
-
+

The type of the position (“O” for offense, etc.)

+
Type

str

@@ -162,8 +203,8 @@

yfpy.models.StatPositionType

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +231,20 @@

yfpy.models.StatPositionType +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Streak.html b/docs/_autosummary/yfpy.models.Streak.html index faec169a..20ec752c 100644 --- a/docs/_autosummary/yfpy.models.Streak.html +++ b/docs/_autosummary/yfpy.models.Streak.html @@ -4,9 +4,12 @@ - yfpy.models.Streak — YFPY v7.0.0 documentation + yfpy.models.Streak — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Streak
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Streak
type
-
+

The streak type (“W” for win, “L” for loss, “T” for tie).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.Streak
value
-
+

The length of the streak.

+
Type

int

@@ -162,8 +202,8 @@

yfpy.models.Streak

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.Streak +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Team.html b/docs/_autosummary/yfpy.models.Team.html index 9f165fbd..a3ef7c03 100644 --- a/docs/_autosummary/yfpy.models.Team.html +++ b/docs/_autosummary/yfpy.models.Team.html @@ -4,9 +4,12 @@ - yfpy.models.Team — YFPY v7.0.0 documentation + yfpy.models.Team — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Team
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.Team
clinched_playoffs
-
+

Numeric boolean (0 or 1) representing if the team has clinched a playoff berth.

+
Type

int

@@ -145,7 +184,8 @@

yfpy.models.Team
division_id
-
+

The unique ID number of the division containing the team (if applicable).

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Team
draft_grade
-
+

The letter grade assigned to the draft completed by the team (“A+”, “A”, …, “F-“).

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.Team
draft_position
-
+

The draft order/position of the team.

+
Type

int

@@ -175,7 +217,8 @@

yfpy.models.Team
draft_recap_url
-
+

The direct URL of the draft recap for the team.

+
Type

str

@@ -185,9 +228,10 @@

yfpy.models.Team
draft_results
-
+

A list of YFPY DraftResult instances.

+
Type
-

list of DraftResult

+

list[DraftResult]

@@ -195,7 +239,8 @@

yfpy.models.Team
faab_balance
-
+

The available balance of FAAB (Free Agent Acquisition Budget) (if applicable).

+
Type

int

@@ -205,7 +250,8 @@

yfpy.models.Team
has_draft_grade
-
+

Numeric boolean (0 or 1) representing if the team has a draft grade available.

+
Type

int

@@ -215,7 +261,9 @@

yfpy.models.Team
league_scoring_type
-
+

Value designating the type of scoring used by the league (“head” for +head-to-head, etc.).

+
Type

str

@@ -223,17 +271,24 @@

yfpy.models.Team -
-managers (list of Manager | dict of str
-

Manager):

+
+managers
+

A list or dict (depending on source data) of YFPY Manager +instances.

+
+
Type
+

list[Manager] | dict[str, Manager]

+
+

matchups
-
+

A list of YFPY Matchup instances.

+
Type
-

list of Matchup

+

list[Matchup]

@@ -241,7 +296,8 @@

yfpy.models.Team
name
-
+

The team name.

+
Type

str

@@ -251,7 +307,8 @@

yfpy.models.Team
number_of_moves
-
+

The number of moves made by the team (adds/drops/trades/etc.).

+
Type

int

@@ -261,7 +318,8 @@

yfpy.models.Team
number_of_trades
-
+

The number of trades made by the team.

+
Type

int

@@ -271,7 +329,8 @@

yfpy.models.Team
roster
-
+

A YFPY Roster instance.

+
Type

Roster

@@ -281,9 +340,10 @@

yfpy.models.Team
players
-
+

A list of YFPY Player instances.

+
Type
-

list of Player

+

list[Player]

@@ -291,7 +351,8 @@

yfpy.models.Team
roster_adds
-
+

A YFPY RosterAdds instance.

+
Type

RosterAdds

@@ -301,7 +362,8 @@

yfpy.models.Team
roster_adds_value
-
+

The number of roster adds made by the team.

+
Type

int

@@ -311,7 +373,8 @@

yfpy.models.Team
team_id
-
+

The unique team ID in the league.

+
Type

int

@@ -321,7 +384,8 @@

yfpy.models.Team
team_key
-
+

The Yahoo team key.

+
Type

str

@@ -331,9 +395,10 @@

yfpy.models.Team
team_logos
-
+

A list of YFPY TeamLogo instances.

+
Type
-

list of TeamLogo

+

list[TeamLogo]

@@ -341,7 +406,8 @@

yfpy.models.Team
team_points
-
+

A YFPY TeamPoints instance.

+
Type

TeamPoints

@@ -351,7 +417,8 @@

yfpy.models.Team
points
-
+

The total points scored by the team.

+
Type

float

@@ -361,7 +428,8 @@

yfpy.models.Team
team_projected_points
-
+

A YFPY TeamProjectedPoints instance.

+
Type

TeamProjectedPoints

@@ -371,7 +439,8 @@

yfpy.models.Team
projected_points
-
+

The total projected points for the team.

+
Type

float

@@ -381,7 +450,8 @@

yfpy.models.Team
team_standings
-
+

A YFPY TeamStandings instance.

+
Type

TeamStandings

@@ -391,7 +461,8 @@

yfpy.models.Team
wins
-
+

The number of wins by the team.

+
Type

int

@@ -401,7 +472,8 @@

yfpy.models.Team
losses
-
+

The number of losses by the team.

+
Type

int

@@ -411,7 +483,8 @@

yfpy.models.Team
ties
-
+

The number of ties by the team.

+
Type

int

@@ -421,7 +494,8 @@

yfpy.models.Team
percentage
-
+

The win percentage of the team.

+
Type

float

@@ -431,7 +505,8 @@

yfpy.models.Team
playoff_seed
-
+

The playoff seed of the team.

+
Type

int

@@ -441,7 +516,8 @@

yfpy.models.Team
points_against
-
+

The total team points against.

+
Type

float

@@ -451,7 +527,8 @@

yfpy.models.Team
points_for
-
+

The total team points for.

+
Type

float

@@ -461,7 +538,8 @@

yfpy.models.Team
rank
-
+

The rank of the team in the league standings.

+
Type

int

@@ -471,7 +549,8 @@

yfpy.models.Team
streak_type
-
+

The active team win/loss/tie streak.

+
Type

str

@@ -481,7 +560,8 @@

yfpy.models.Team
streak_length
-
+

The length of the streak.

+
Type

int

@@ -491,7 +571,8 @@

yfpy.models.Team
url
-
+

The direct URL to the team.

+
Type

str

@@ -501,7 +582,8 @@

yfpy.models.Team
waiver_priority
-
+

The waiver priority of the team.

+
Type

int

@@ -511,7 +593,9 @@

yfpy.models.Team
win_probability
-
+

The active win probability of the team in its current matchup (ranges from 0.0 to +1.0).

+
Type

float

@@ -528,8 +612,8 @@

yfpy.models.Team

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -556,6 +640,20 @@

yfpy.models.Team +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.TeamLogo.html b/docs/_autosummary/yfpy.models.TeamLogo.html index d5582039..174d464a 100644 --- a/docs/_autosummary/yfpy.models.TeamLogo.html +++ b/docs/_autosummary/yfpy.models.TeamLogo.html @@ -4,9 +4,12 @@ - yfpy.models.TeamLogo — YFPY v7.0.0 documentation + yfpy.models.TeamLogo — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.TeamLogo
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.TeamLogo
size
-
+

The size of the team logo photo (“small”, “large”, etc.)

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.TeamLogo
url
-
+

The direct URL of the team logo photo.

+
Type

str

@@ -162,8 +202,8 @@

yfpy.models.TeamLogo

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -190,6 +230,20 @@

yfpy.models.TeamLogo

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.TeamPoints.html b/docs/_autosummary/yfpy.models.TeamPoints.html index e9aaf1e7..b0fcb2ec 100644 --- a/docs/_autosummary/yfpy.models.TeamPoints.html +++ b/docs/_autosummary/yfpy.models.TeamPoints.html @@ -4,9 +4,12 @@ - yfpy.models.TeamPoints — YFPY v7.0.0 documentation + yfpy.models.TeamPoints — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.TeamPoints
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.TeamPoints
coverage_type
-
+

The timeframe for the selected team points (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.TeamPoints
season
-
+

The season year.

+
Type

int

@@ -155,7 +195,8 @@

yfpy.models.TeamPoints
total
-
+

The total team points for the coverage timeframe.

+
Type

float

@@ -165,7 +206,8 @@

yfpy.models.TeamPoints
week
-
+

The week number (if applicable).

+
Type

int

@@ -182,8 +224,8 @@

yfpy.models.TeamPoints

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -210,6 +252,20 @@

yfpy.models.TeamPoints

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.TeamProjectedPoints.html b/docs/_autosummary/yfpy.models.TeamProjectedPoints.html index 873f91f0..db7cfbd0 100644 --- a/docs/_autosummary/yfpy.models.TeamProjectedPoints.html +++ b/docs/_autosummary/yfpy.models.TeamProjectedPoints.html @@ -4,9 +4,12 @@ - yfpy.models.TeamProjectedPoints — YFPY v7.0.0 documentation + yfpy.models.TeamProjectedPoints — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.TeamProjectedPoints
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.TeamProjectedPoints
coverage_type
-
+

The timeframe for the selected team projected points (“week”, “date”, “season”, etc.).

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.TeamProjectedPoints
total
-
+

The total team projected points for the coverage timeframe.

+
Type

float

@@ -155,7 +195,8 @@

yfpy.models.TeamProjectedPoints
week
-
+

The week number.

+
Type

int

@@ -172,8 +213,8 @@

yfpy.models.TeamProjectedPoints

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -200,6 +241,20 @@

yfpy.models.TeamProjectedPoints +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.TeamStandings.html b/docs/_autosummary/yfpy.models.TeamStandings.html index 9532e6e3..a343bfa9 100644 --- a/docs/_autosummary/yfpy.models.TeamStandings.html +++ b/docs/_autosummary/yfpy.models.TeamStandings.html @@ -4,9 +4,12 @@ - yfpy.models.TeamStandings — YFPY v7.0.0 documentation + yfpy.models.TeamStandings — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.TeamStandings
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.TeamStandings
divisional_outcome_totals
-
+

A list of YFPY DivisionalOutcomeTotals instances.

+
Type

DivisionalOutcomeTotals

@@ -145,7 +184,8 @@

yfpy.models.TeamStandings
outcome_totals
-
+

A YFPY OutcomeTotals instance.

+
Type

OutcomeTotals

@@ -155,7 +195,8 @@

yfpy.models.TeamStandings
playoff_seed
-
+

The playoff seed position for the team.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.TeamStandings
points_against
-
+

The total team points against.

+
Type

float

@@ -175,7 +217,8 @@

yfpy.models.TeamStandings
points_for
-
+

The total team points for.

+
Type

float

@@ -185,7 +228,8 @@

yfpy.models.TeamStandings
rank
-
+

The rank of the team in the league standings.

+
Type

int

@@ -195,7 +239,8 @@

yfpy.models.TeamStandings
streak
-
+

A YFPY Streak instance.

+
Type

Streak

@@ -212,8 +257,8 @@

yfpy.models.TeamStandings

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -240,6 +285,20 @@

yfpy.models.TeamStandings +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.Transaction.html b/docs/_autosummary/yfpy.models.Transaction.html index 798f8982..bec37b67 100644 --- a/docs/_autosummary/yfpy.models.Transaction.html +++ b/docs/_autosummary/yfpy.models.Transaction.html @@ -4,9 +4,12 @@ - yfpy.models.Transaction — YFPY v7.0.0 documentation + yfpy.models.Transaction — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.Transaction
    • -
+
@@ -135,9 +173,10 @@

yfpy.models.Transaction
players
-
+

A list of YFPY Player instances.

+
Type
-

list of Player

+

list[Player]

@@ -145,7 +184,8 @@

yfpy.models.Transaction
status
-
+

The transaction status (“successful”, etc.).

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.Transaction
timestamp
-
+

The timestamp of when the transaction occurred.

+
Type

int

@@ -165,7 +206,8 @@

yfpy.models.Transaction
tradee_team_key
-
+

The Yahoo team key for the team receiving the player (if applicable).

+
Type

str

@@ -175,7 +217,8 @@

yfpy.models.Transaction
tradee_team_name
-
+

The team name of the team receiving the player (if applicable).

+
Type

str

@@ -185,7 +228,8 @@

yfpy.models.Transaction
trader_team_key
-
+

The Yahoo team key for the team sending the player (if applicable).

+
Type

str

@@ -195,7 +239,8 @@

yfpy.models.Transaction
trader_team_name
-
+

The team name for the team sending the player (if applicable).

+
Type

str

@@ -205,7 +250,8 @@

yfpy.models.Transaction
transaction_id
-
+

The unique transaction ID number.

+
Type

int

@@ -215,7 +261,8 @@

yfpy.models.Transaction
transaction_key
-
+

The Yahoo transaction key (Ex.: “406.l.413954.tr.555”).

+
Type

str

@@ -225,7 +272,8 @@

yfpy.models.Transaction
type
-
+

The type of the transaction (“add”, “drop”, “trade”, etc.).

+
Type

str

@@ -242,8 +290,8 @@

yfpy.models.Transaction

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -270,6 +318,20 @@

yfpy.models.Transaction

+
+
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+
+
serialized()
diff --git a/docs/_autosummary/yfpy.models.TransactionData.html b/docs/_autosummary/yfpy.models.TransactionData.html index 05ae7fc1..1cd0ceba 100644 --- a/docs/_autosummary/yfpy.models.TransactionData.html +++ b/docs/_autosummary/yfpy.models.TransactionData.html @@ -4,9 +4,12 @@ - yfpy.models.TransactionData — YFPY v7.0.0 documentation + yfpy.models.TransactionData — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.TransactionData
    • -
+
@@ -135,7 +173,8 @@

yfpy.models.TransactionData
destination_team_key
-
+

The Yahoo team key for the receiving team.

+
Type

str

@@ -145,7 +184,8 @@

yfpy.models.TransactionData
destination_team_name
-
+

The name of the receiving team.

+
Type

str

@@ -155,7 +195,8 @@

yfpy.models.TransactionData
destination_type
-
+

The destination of the player (waivers, free agency, another team, etc.).

+
Type

str

@@ -165,7 +206,8 @@

yfpy.models.TransactionData
source_team_key
-
+

The Yahoo team key of the sending team.

+
Type

str

@@ -175,7 +217,8 @@

yfpy.models.TransactionData
source_team_name
-
+

The name of the sending team.

+
Type

str

@@ -185,7 +228,8 @@

yfpy.models.TransactionData
source_type
-
+

The origin of the player (waivers, free agency, another team, etc.).

+
Type

str

@@ -195,7 +239,8 @@

yfpy.models.TransactionData
type
-
+

The type of the transaction (“add”, “drop”, “trade”, etc.).

+
Type

str

@@ -212,8 +257,8 @@

yfpy.models.TransactionData

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -240,6 +285,20 @@

yfpy.models.TransactionData +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.User.html b/docs/_autosummary/yfpy.models.User.html index 178858c6..c1b9cd47 100644 --- a/docs/_autosummary/yfpy.models.User.html +++ b/docs/_autosummary/yfpy.models.User.html @@ -4,9 +4,12 @@ - yfpy.models.User — YFPY v7.0.0 documentation + yfpy.models.User — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.User
    • -
+
@@ -135,10 +173,10 @@

yfpy.models.User
games
-

List of Yahoo Fantasy games in which the user participates/has participated.

+

The Yahoo Fantasy games in which the user participates/has participated.

Type
-

list of Game

+

list[Game]

@@ -146,7 +184,7 @@

yfpy.models.User
guid
-

Yahoo user ID.

+

The Yahoo user ID.

Type

str

@@ -164,8 +202,8 @@

yfpy.models.User

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -192,6 +230,20 @@

yfpy.models.User +
+classmethod from_json(json_data)
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()
diff --git a/docs/_autosummary/yfpy.models.YahooFantasyObject.html b/docs/_autosummary/yfpy.models.YahooFantasyObject.html index b45ef384..b1b1cff0 100644 --- a/docs/_autosummary/yfpy.models.YahooFantasyObject.html +++ b/docs/_autosummary/yfpy.models.YahooFantasyObject.html @@ -4,9 +4,12 @@ - yfpy.models.YahooFantasyObject — YFPY v7.0.0 documentation + yfpy.models.YahooFantasyObject — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -113,7 +148,10 @@
  • yfpy.models.YahooFantasyObject
    • -
+
@@ -153,8 +191,8 @@

yfpy.models.YahooFantasyObject

clean_data_dict

Recursive method to un-type custom class type objects for serialization.

-

from_json

-

+

from_json

+

Deserialize JSON to a class object.

serialized

Pack up all object content into nested dictionaries for JSON serialization.

@@ -181,6 +219,20 @@

yfpy.models.YahooFantasyObject +
+classmethod from_json(json_data)[source]
+

Deserialize JSON to a class object.

+
+
Returns
+

Class object derived from JSON data.

+
+
Return type
+

object

+
+
+

+
serialized()[source]
diff --git a/docs/_autosummary/yfpy.models.html b/docs/_autosummary/yfpy.models.html index 6355e8c3..6591f99d 100644 --- a/docs/_autosummary/yfpy.models.html +++ b/docs/_autosummary/yfpy.models.html @@ -4,9 +4,12 @@ - yfpy.models — YFPY v7.0.0 documentation + yfpy.models — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -112,7 +147,10 @@
  • yfpy.models
    • -
+
diff --git a/docs/_autosummary/yfpy.query.YahooFantasySportsQuery.html b/docs/_autosummary/yfpy.query.YahooFantasySportsQuery.html index 0d48b198..7038c298 100644 --- a/docs/_autosummary/yfpy.query.YahooFantasySportsQuery.html +++ b/docs/_autosummary/yfpy.query.YahooFantasySportsQuery.html @@ -4,9 +4,12 @@ - yfpy.query.YahooFantasySportsQuery — YFPY v7.0.0 documentation + yfpy.query.YahooFantasySportsQuery — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
-
+
  • »
    • @@ -72,7 +148,10 @@
  • yfpy.query.YahooFantasySportsQuery
    • -
+
@@ -92,20 +171,22 @@

yfpy.query.YahooFantasySportsQuerystr) – Location of both private.json (containing Yahoo dev app consumer_key and consumer_secret) and token.json (generated by OAuth2 three-legged handshake).

  • league_id (str) – League ID of selected Yahoo Fantasy league.

    • -

  • game_id (int, optional) – Game ID of selected Yahoo fantasy game corresponding to a specific year, and +

  • game_id (int, optional) – Game ID of selected Yahoo fantasy game corresponding to a specific year, and defaulting to the current year.

    • -

  • game_code (str, optional) – Game code of selected Yahoo Fantasy game corresponding to a specific year, and -defaulting to “nfl” (fantasy football), “nhl” (fantasy hockey), “mlb” (fantasy baseball), or “nba” +

  • game_code (str, optional) – Game code of selected Yahoo Fantasy game corresponding to a specific year, +and defaulting to “nfl” (fantasy football), “nhl” (fantasy hockey), “mlb” (fantasy baseball), or “nba” (fantasy basketball)

    • -

  • offline (bool, optional) – Boolean to run in offline mode (Only works if all needed Yahoo Fantasy data has -been previously saved locally using the Data module in data.py).

    • -

  • all_output_as_json (bool, optional) – Option to automatically convert all query output to JSON strings.

    • -

  • consumer_key (str, optional) – User defined consumer key to use instead of values stored in the private.json -file (must be defined alongside a user defined consumer secret).

    • -

  • consumer_secret (str, optional) – User defined consumer secret to use instead of values stored in the +

  • offline (bool, optional) – Boolean to run in offline mode (Only works if all needed Yahoo Fantasy data +has been previously saved locally using the Data module in data.py).

    • +

  • all_output_as_json (bool, optional) – Option to automatically convert all query output to JSON +strings.

    • +

  • consumer_key (str, optional) – User defined consumer key to use instead of values stored in the +private.json file (must be defined alongside a user defined consumer secret).

    • +

  • consumer_secret (str, optional) – User defined consumer secret to use instead of values stored in the private.json file (must be defined alongside a user defined consumer key).

    • -

  • browser_callback (bool, optional) – Enable or disable (enabled by default) whether the yahoo-oauth library -automatically opens a browser window to authenticate (if disabled, it will output the callback URL).

    • +

  • browser_callback (bool, optional) – Enable or disable (enabled by default) whether the yahoo-oauth +library automatically opens a browser window to authenticate (if disabled, it will output the callback +URL).

    • @@ -256,9 +337,14 @@

    yfpy.query.YahooFantasySportsQuery -
    -executed_queries (list of dict of str
    -

    Any): List of completed queries and their responses.

    +
    +executed_queries
    +

    List of completed queries and their responses.

    +
    +
    Type
    +

    list[dict[str, Any]]

    +
    +

    Methods

    @@ -436,7 +522,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Game instances.

    Return type
    -

    list

    +

    list[Game]

    @@ -752,7 +838,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY PositionType instances.

    Return type
    -

    list

    +

    list[PositionType]

    @@ -790,7 +876,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY RosterPosition instances.

    Return type
    -

    list

    +

    list[RosterPosition]

    @@ -878,7 +964,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY GameWeek instances.

    Return type
    -

    list

    +

    list[GameWeek]

    @@ -908,7 +994,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY DraftResult instances.

    Return type
    -

    list

    +

    list[DraftResult]

    @@ -1065,7 +1151,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Matchup instances.

    Return type
    -

    list

    +

    list[Matchup]

    @@ -1180,7 +1266,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Player instances.

    Return type
    -

    list

    +

    list[Player]

    @@ -1480,7 +1566,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Team instances.

    Return type
    -

    list

    +

    list[Team]

    @@ -1536,7 +1622,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Transaction instances.

    Return type
    -

    list

    +

    list[Transaction]

    @@ -1775,8 +1861,11 @@

    yfpy.query.YahooFantasySportsQuery get_player_stats_by_date(player_key, chosen_date=None)[source]

    Retrieve player stats by player_key and by date for chosen league.

    -

    Note: This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.

    -

    Warning: This query will FAIL if you pass it an INVALID date string!

    +
    +

    Note

    +

    This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues. +This query will FAIL if you pass it an INVALID date string!

    +
    Parameters
      @@ -2039,9 +2128,9 @@

      yfpy.query.YahooFantasySportsQueryParameters

      • url (str) – REST API request URL string.

        • -

      • retries (int, optional) – Number of times to retry a query if it fails (defaults to 3).

        • -

      • backoff (int, optional) – Multiplier that incrementally increases the wait time before retrying a failed -query request.

        • +

      • retries (int, optional) – Number of times to retry a query if it fails (defaults to 3).

        • +

      • backoff (int, optional) – Multiplier that incrementally increases the wait time before retrying a +failed query request.

      Returns
      @@ -2059,7 +2148,7 @@

      yfpy.query.YahooFantasySportsQuery
      Parameters
      -

      team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

      team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2084,7 +2173,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY DraftResult instances.

    Return type
    -

    list

    +

    list[DraftResult]

    @@ -2095,7 +2184,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2183,7 +2272,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2204,7 +2293,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Matchup instances.

    Return type
    -

    list

    +

    list[Matchup]

    @@ -2215,7 +2304,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2274,7 +2363,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
      -

    • team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    • team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    • chosen_week (int) – Selected week for which to retrieve data.

    @@ -2349,12 +2438,15 @@

    yfpy.query.YahooFantasySportsQuery get_team_roster_player_info_by_date(team_id, chosen_date=None)[source]

    Retrieve roster with ALL player info of specific team by team_id and by date for chosen league.

    -

    Note: This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.

    -

    Warning: This query will FAIL if you pass it an INVALID date string!

    +
    +

    Note

    +

    This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues. +This query will FAIL if you pass it an INVALID date string!

    +
    Parameters
      -

    • team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    • team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    • chosen_date (str) – Selected date for which to retrieve data. REQUIRED FORMAT: YYYY-MM-DD (Ex. 2011-05-01)

    @@ -2363,19 +2455,86 @@

    yfpy.query.YahooFantasySportsQueryExamples

    >>> query = YahooFantasySportsQuery(Path("/path/to/auth/directory"), league_id="######")
 >>> query.get_team_roster_player_info_by_date(1, "2011-05-01")
-TODO: EXAMPLE
+[
+  {
+    "player": {
+      "display_position": "C",
+      "draft_analysis": {
+        "average_pick": 33.2,
+        "average_round": 3.5,
+        "average_cost": 39.2,
+        "percent_drafted": 1.0
+      },
+      "editorial_player_key": "nhl.p.3981",
+      "editorial_team_abbr": "Chi",
+      "editorial_team_full_name": "Chicago Blackhawks",
+      "editorial_team_key": "nhl.t.4",
+      "eligible_positions": [
+        "C",
+        "F"
+      ],
+      "has_player_notes": 1,
+      "headshot": {
+        "size": "small",
+        "url": "https://s.yimg.com/iu/api/res/1.2/tz.KOMoEiBDch6AJAGaUtg--~C/
+        YXBwaWQ9eXNwb3J0cztjaD0yMzM2O2NyPTE7Y3c9MTc5MDtkeD04NTc7ZHk9MDtmaT11bGNyb3A7aD02MDtxPTEwMDt3PTQ2/https://s.yimg.com/xe/i/us/sp/v/nhl_cutout/players_l/11032021/3981.png"
+      },
+      "is_editable": 0,
+      "is_undroppable": 0,
+      "name": {
+        "ascii_first": "Jonathan",
+        "ascii_last": "Toews",
+        "first": "Jonathan",
+        "full": "Jonathan Toews",
+        "last": "Toews"
+      },
+      "ownership": {
+        "ownership_type": "team",
+        "owner_team_key": "303.l.69624.t.2",
+        "owner_team_name": "The Bateleurs"
+      },
+      "percent_owned": {
+        "coverage_type": "week",
+        "week": 25,
+        "value": 98,
+        "delta": -1.0
+      },
+      "player_id": 3981,
+      "player_key": "303.p.3981",
+      "player_notes_last_timestamp": 1651606838,
+      "player_stats": {
+        "coverage_type": "date",
+        "stats": [
+          {
+            "stat": {
+              "stat_id": 1,
+              "value": 1.0
+            }
+          },
+          ...
+        ]
+      },
+      "position_type": "P",
+      "primary_position": "C",
+      "selected_position": {
+        "coverage_type": "date",
+        "is_flex": 0,
+        "position": "C"
+      },
+      "uniform_number": 19
+    }
+  },
+  ...
+]
    Returns
    -

    -
    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, “percent_owned”, and

    ”player_stats”, which each return instances of their respective YFPY objects.

    -
    -
    -

    +

    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, +“percent_owned”, and “player_stats”, which each return instances of their respective YFPY objects.

    Return type
    -

    list

    +

    list[Player]

    @@ -2387,7 +2546,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
      -

    • team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    • team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    • chosen_week (int) – Selected week for which to retrieve data.

    @@ -2479,14 +2638,11 @@

    yfpy.query.YahooFantasySportsQuery
    Returns
    -

    -
    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, “percent_owned”, and

    ”player_stats”, which each return instances of their respective YFPY objects.

    -
    -
    -

    +

    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, +“percent_owned”, and “player_stats”, which each return instances of their respective YFPY objects.

    Return type
    -

    list

    +

    list[Player]

    @@ -2497,7 +2653,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2574,14 +2730,11 @@

    yfpy.query.YahooFantasySportsQuery
    Returns
    -

    -
    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, “percent_owned”, and

    ”player_stats”, which each return instances of their respective YFPY objects.

    -
    -
    -

    +

    List of YFPY Player instances containing the keys “draft_analysis”, “ownership”, +“percent_owned”, and “player_stats”, which each return instances of their respective YFPY objects.

    Return type
    -

    list

    +

    list[Player]

    @@ -2593,7 +2746,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
      -

    • team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    • team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    • chosen_week (int) – Selected week for which to retrieve data.

    @@ -2669,10 +2822,11 @@

    yfpy.query.YahooFantasySportsQuery
    Returns
    -

    List of YFPY Player instances containing the “player_stats” key (returns a YFPY PlayerStats instance).

    +

    List of YFPY Player instances containing the “player_stats” key (returns a YFPY PlayerStats +instance).

    Return type
    -

    list

    +

    list[Player]

    @@ -2683,7 +2837,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2724,7 +2878,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
    -

    team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    @@ -2755,7 +2909,7 @@

    yfpy.query.YahooFantasySportsQuery
    Parameters
      -

    • team_id (type) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the +

    • team_id (str) – Selected team ID for which to retrieva data (can be integers 1 through n where n is the number of teams in the league).

    • chosen_week (int) – Selected week for which to retrieve data.

    @@ -2780,14 +2934,11 @@

    yfpy.query.YahooFantasySportsQuery
    Returns
    -

    -
    Dictionary containing both a YFPY TeamPoints instance and a YFPY TeamProjectedPoints instance with

    respective keys “team_points” and “team_projected_points”.

    -
    -
    -

    +

    Dictionary containing both a YFPY TeamPoints instance and a +YFPY TeamProjectedPoints instance with respective keys “team_points” and “team_projected_points”.

    Return type
    -

    dict

    +

    dict[str, TeamPoints | TeamProjectedPoints]

    @@ -2823,7 +2974,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Game instances.

    Return type
    -

    list

    +

    list[Game]

    @@ -2881,7 +3032,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY League instances.

    Return type
    -

    list

    +

    list[League]

    @@ -2959,7 +3110,7 @@

    yfpy.query.YahooFantasySportsQuery

    List of YFPY Game instances with “teams” field containing list of YFPY Team instances.

    Return type
    -

    list

    +

    list[Game]

    @@ -2972,22 +3123,20 @@

    yfpy.query.YahooFantasySportsQueryParameters

    • url (str) – REST API request URL string.

      • -

    • data_key_list (list of str | list of list of str) – List of keys used to extract the specific data desired -by the given query (supports strings and lists of strings). Usage is as follows: -List containing only key strings: [“game”, “stat_categories”] -List containing key strings and lists of key strings: [“team”, [“team_points”, “team_projected_points”]]

      • -

    • data_type_class (Type, optional) – Highest level data model type (if one exists for the retrieved data).

      • +

    • data_key_list (list[str] | list[list[str]]) – List of keys used to extract the specific data desired by the +given query (supports strings and lists of strings). Supports lists containing only key strings such as +[“game”, “stat_categories”], and also supports lists containing key strings and lists of key strings +such as [“team”, [“team_points”, “team_projected_points”]].

      • +

    • data_type_class (Type, optional) – Highest level data model type (if one exists for the retrieved +data).

    -
    Return type
    -

    Union[str, YahooFantasyObject, List[YahooFantasyObject], Dict[str, YahooFantasyObject]]

    -
    -
    Returns
    -

    -
    Model class instance from yfpy/models.py, dictionary, or list (depending on query), with unpacked and parsed

    response data.

    +
    Returns
    +

    Model class instance from yfpy/models.py, dictionary, or list (depending on query), with unpacked +and parsed response data.

    -
    -

    +
    Return type
    +

    object

    diff --git a/docs/_autosummary/yfpy.query.html b/docs/_autosummary/yfpy.query.html index d3d24eaa..cb05acc9 100644 --- a/docs/_autosummary/yfpy.query.html +++ b/docs/_autosummary/yfpy.query.html @@ -4,9 +4,12 @@ - yfpy.query — YFPY v7.0.0 documentation + yfpy.query — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -71,7 +147,10 @@
    • yfpy.query
      • -
    +
    diff --git a/docs/_autosummary/yfpy.utils.complex_json_handler.html b/docs/_autosummary/yfpy.utils.complex_json_handler.html index a43f9542..187fa95f 100644 --- a/docs/_autosummary/yfpy.utils.complex_json_handler.html +++ b/docs/_autosummary/yfpy.utils.complex_json_handler.html @@ -4,9 +4,12 @@ - yfpy.utils.complex_json_handler — YFPY v7.0.0 documentation + yfpy.utils.complex_json_handler — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.complex_json_handler
      • -
    +
    @@ -98,11 +167,11 @@

    yfpy.utils.complex_json_handlerParameters

    obj (Any) – Unserializable Python object to be serialized into JSON.

    -
    Return type
    -

    Any

    +
    Returns
    +

    Serializable version of the Python object.

    -
    Returns
    -

    Serializable version of the Python object.

    +
    Return type
    +

    Any

    diff --git a/docs/_autosummary/yfpy.utils.convert_strings_to_numeric_equivalents.html b/docs/_autosummary/yfpy.utils.convert_strings_to_numeric_equivalents.html index 294ae2e6..8905e164 100644 --- a/docs/_autosummary/yfpy.utils.convert_strings_to_numeric_equivalents.html +++ b/docs/_autosummary/yfpy.utils.convert_strings_to_numeric_equivalents.html @@ -4,9 +4,12 @@ - yfpy.utils.convert_strings_to_numeric_equivalents — YFPY v7.0.0 documentation + yfpy.utils.convert_strings_to_numeric_equivalents — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.convert_strings_to_numeric_equivalents
      • -
    +
    @@ -98,15 +167,12 @@

    yfpy.utils.convert_strings_to_numeric_equivalentsParameters

    json_obj (Any) – JSON object (typically a dictionary or list, but can also be a primitive).

    -
    Return type
    -

    Union[int, float, Any]

    -
    -
    Returns
    -

    -
    The numeric representation of any JSON strings that can be represented as integers or floats, else the

    original JSON object.

    +
    Returns
    +

    The numeric representation of any JSON strings that can be represented as integers or floats, +else the original JSON object.

    -
    -

    +
    Return type
    +

    int | float | Any

    diff --git a/docs/_autosummary/yfpy.utils.dict_to_list.html b/docs/_autosummary/yfpy.utils.dict_to_list.html index d329ed54..d2a65412 100644 --- a/docs/_autosummary/yfpy.utils.dict_to_list.html +++ b/docs/_autosummary/yfpy.utils.dict_to_list.html @@ -4,9 +4,12 @@ - yfpy.utils.dict_to_list — YFPY v7.0.0 documentation + yfpy.utils.dict_to_list — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.dict_to_list
      • -
    +
    @@ -96,13 +165,14 @@

    yfpy.utils.dict_to_list

    Function to convert a JSON dictionary to a list.

    Parameters
    -

    str (json_dict (dict of) – Any): JSON dictionary.

    +

    json_dict (dict[str, Any]) – JSON dictionary.

    -
    Return type
    -

    Any

    +
    Returns
    +

    A list derived from a JSON dictionary, or the original dictionary if it does not contain dictionaries as +values.

    -
    Returns
    -

    A list derived from a JSON dictionary, or the original dictionary if it does not contain dictionaries as values.

    +
    Return type
    +

    list

    diff --git a/docs/_autosummary/yfpy.utils.flatten_json_dict_list.html b/docs/_autosummary/yfpy.utils.flatten_json_dict_list.html index 8efe3748..35ad5b52 100644 --- a/docs/_autosummary/yfpy.utils.flatten_json_dict_list.html +++ b/docs/_autosummary/yfpy.utils.flatten_json_dict_list.html @@ -4,9 +4,12 @@ - yfpy.utils.flatten_json_dict_list — YFPY v7.0.0 documentation + yfpy.utils.flatten_json_dict_list — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.flatten_json_dict_list
      • -
    +
    @@ -97,15 +166,15 @@

    yfpy.utils.flatten_json_dict_list
    Parameters
    -
    Return type
    -

    Any

    +
    Returns
    +

    Returns a dictionary if the list was flattened, else a cleaned list if no flattening was needed.

    -
    Returns
    -

    Returns a dictionary if the list was flattened, else a cleaned list if no flattening was needed.

    +
    Return type
    +

    dict | list

    diff --git a/docs/_autosummary/yfpy.utils.flatten_to_list.html b/docs/_autosummary/yfpy.utils.flatten_to_list.html index 139f5a9f..17c87261 100644 --- a/docs/_autosummary/yfpy.utils.flatten_to_list.html +++ b/docs/_autosummary/yfpy.utils.flatten_to_list.html @@ -4,9 +4,12 @@ - yfpy.utils.flatten_to_list — YFPY v7.0.0 documentation + yfpy.utils.flatten_to_list — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.flatten_to_list
      • -
    +
    @@ -98,15 +167,12 @@

    yfpy.utils.flatten_to_listParameters

    json_obj (Any) – JSON object (typically a dictionary or list, but can also be a primitive).

    -
    Return type
    -

    Any

    -
    -
    Returns
    -

    -
    A list made from a flattened dictionary if json_obj was a dictionary, the original list if json_obj was a list,

    or the original value if json_obj was a primitive.

    +
    Returns
    +

    A list made from a flattened dictionary if json_obj was a dictionary, the original list if json_obj was a +list, or the original value if json_obj was a primitive.

    -
    -

    +
    Return type
    +

    list

    diff --git a/docs/_autosummary/yfpy.utils.flatten_to_objects.html b/docs/_autosummary/yfpy.utils.flatten_to_objects.html index 1d88110f..38239daf 100644 --- a/docs/_autosummary/yfpy.utils.flatten_to_objects.html +++ b/docs/_autosummary/yfpy.utils.flatten_to_objects.html @@ -4,9 +4,12 @@ - yfpy.utils.flatten_to_objects — YFPY v7.0.0 documentation + yfpy.utils.flatten_to_objects — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.flatten_to_objects
      • -
    +
    @@ -98,11 +167,11 @@

    yfpy.utils.flatten_to_objectsParameters

    json_obj (Any) – JSON object (typically a dictionary or list, but can also be a primitive).

    -
    Return type
    -

    Any

    +
    Returns
    +

    JSON dictionary/list/primitive with contents cast to Python objects.

    -
    Returns
    -

    JSON dictionary/list/primitive with contents cast to Python objects.

    +
    Return type
    +

    dict | list | int | float | str | bool

    diff --git a/docs/_autosummary/yfpy.utils.get_type.html b/docs/_autosummary/yfpy.utils.get_type.html index fb28981d..09946235 100644 --- a/docs/_autosummary/yfpy.utils.get_type.html +++ b/docs/_autosummary/yfpy.utils.get_type.html @@ -4,9 +4,12 @@ - yfpy.utils.get_type — YFPY v7.0.0 documentation + yfpy.utils.get_type — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.get_type
      • -
    +
    @@ -103,11 +172,11 @@

    yfpy.utils.get_typeReturn type -

    Dict[str, Any]

    +
    Returns
    +

    A Python object (representing the original JSON object) that has been cast to the specified type.

    -
    Returns
    -

    A Python object (representing the original JSON object) that has been cast to the specified types.

    +
    Return type
    +

    object

    diff --git a/docs/_autosummary/yfpy.utils.html b/docs/_autosummary/yfpy.utils.html index cc2bb11b..999867b6 100644 --- a/docs/_autosummary/yfpy.utils.html +++ b/docs/_autosummary/yfpy.utils.html @@ -4,9 +4,12 @@ - yfpy.utils — YFPY v7.0.0 documentation + yfpy.utils — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -81,7 +147,10 @@
    • yfpy.utils
      • -
    +
    diff --git a/docs/_autosummary/yfpy.utils.prettify_data.html b/docs/_autosummary/yfpy.utils.prettify_data.html index e0780534..a365e72c 100644 --- a/docs/_autosummary/yfpy.utils.prettify_data.html +++ b/docs/_autosummary/yfpy.utils.prettify_data.html @@ -4,9 +4,12 @@ - yfpy.utils.prettify_data — YFPY v7.0.0 documentation + yfpy.utils.prettify_data — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.prettify_data
      • -
    +
    @@ -98,11 +167,11 @@

    yfpy.utils.prettify_dataParameters

    data (str) – Data formatted as a JSON string.

    -
    Return type
    -

    str

    +
    Returns
    +

    JSON string that has been formatted with indents (two spaces).

    -
    Returns
    -

    The return value. True for success, False otherwise.

    +
    Return type
    +

    str

    diff --git a/docs/_autosummary/yfpy.utils.reformat_json_list.html b/docs/_autosummary/yfpy.utils.reformat_json_list.html index c1068e85..780a4551 100644 --- a/docs/_autosummary/yfpy.utils.reformat_json_list.html +++ b/docs/_autosummary/yfpy.utils.reformat_json_list.html @@ -4,9 +4,12 @@ - yfpy.utils.reformat_json_list — YFPY v7.0.0 documentation + yfpy.utils.reformat_json_list — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.reformat_json_list
      • -
    +
    @@ -98,11 +167,11 @@

    yfpy.utils.reformat_json_listParameters

    json_obj (Any) – JSON object (typically a dictionary or list, but can also be a primitive) to be cleaned.

    -
    Return type
    -

    Any

    +
    Returns
    +

    Reformatted JSON list derived from original JSON object.

    -
    Returns
    -

    Reformatted JSON list derived from original JSON object.

    +
    Return type
    +

    Any

    diff --git a/docs/_autosummary/yfpy.utils.reorganize_json_dict.html b/docs/_autosummary/yfpy.utils.reorganize_json_dict.html index dcd54c8d..df0bfe33 100644 --- a/docs/_autosummary/yfpy.utils.reorganize_json_dict.html +++ b/docs/_autosummary/yfpy.utils.reorganize_json_dict.html @@ -4,9 +4,12 @@ - yfpy.utils.reorganize_json_dict — YFPY v7.0.0 documentation + yfpy.utils.reorganize_json_dict — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -27,8 +32,12 @@
    -
    +
    • »
      • @@ -82,7 +148,10 @@
    • yfpy.utils.reorganize_json_dict
      • -
    +
    @@ -103,11 +172,11 @@

    yfpy.utils.reorganize_json_dictstr) – Key used to sort the dictionaries contained in json_dict.

    -
    Return type
    -

    OrderedDict[str, Any]

    +
    Returns
    +

    An ordered dictionary of dictionaries sorted by val_to_key.

    -
    Returns
    -

    An ordered dictionary of dictionaries sorted by val_to_key.

    +
    Return type
    +

    dict[str, Any]

    diff --git a/docs/_autosummary/yfpy.utils.unpack_data.html b/docs/_autosummary/yfpy.utils.unpack_data.html index 49d19e57..5c1fa9c2 100644 --- a/docs/_autosummary/yfpy.utils.unpack_data.html +++ b/docs/_autosummary/yfpy.utils.unpack_data.html @@ -4,9 +4,12 @@ - yfpy.utils.unpack_data — YFPY v7.0.0 documentation + yfpy.utils.unpack_data — YFPY v7.0.2 documentation + + + @@ -15,6 +18,8 @@ + + @@ -26,8 +31,12 @@
    -
    +
    • »
      • @@ -81,7 +147,9 @@
    • yfpy.utils.unpack_data
      • -
    +
    @@ -100,11 +168,11 @@

    yfpy.utils.unpack_data

    parent_class (Type) – Parent class type used to extract custom subclass type options for casting.

    -
    Return type
    -

    Any

    +
    Returns
    +

    Recursively returns JSON objects until data is completely parsed, cleaned, and typed (where applicable).

    -
    Returns
    -

    Recursively returns JSON objects until data is completely parsed, cleaned, and typed (where applicable).

    +
    Return type
    +

    Any

    diff --git a/docs/_modules/index.html b/docs/_modules/index.html index 401b8d4f..f81d0a22 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -3,9 +3,12 @@ - Overview: module code — YFPY v7.0.0 documentation + Overview: module code — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + @@ -24,8 +29,12 @@
    -
    +
    • »
      • diff --git a/docs/_modules/yfpy/data.html b/docs/_modules/yfpy/data.html index 67cf755e..9572ff71 100644 --- a/docs/_modules/yfpy/data.html +++ b/docs/_modules/yfpy/data.html @@ -3,9 +3,12 @@ - yfpy.data — YFPY v6.0.0 documentation + yfpy.data — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + diff --git a/docs/_modules/yfpy/exceptions.html b/docs/_modules/yfpy/exceptions.html index b1642703..70d2252b 100644 --- a/docs/_modules/yfpy/exceptions.html +++ b/docs/_modules/yfpy/exceptions.html @@ -3,9 +3,12 @@ - yfpy.exceptions — YFPY v6.0.0 documentation + yfpy.exceptions — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + diff --git a/docs/_modules/yfpy/logger.html b/docs/_modules/yfpy/logger.html index a80ecd83..753e1f17 100644 --- a/docs/_modules/yfpy/logger.html +++ b/docs/_modules/yfpy/logger.html @@ -3,9 +3,12 @@ - yfpy.logger — YFPY v6.0.0 documentation + yfpy.logger — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + diff --git a/docs/_modules/yfpy/models.html b/docs/_modules/yfpy/models.html index fda2e5f4..b4752ca7 100644 --- a/docs/_modules/yfpy/models.html +++ b/docs/_modules/yfpy/models.html @@ -3,9 +3,12 @@ - yfpy.models — YFPY v6.0.0 documentation + yfpy.models — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + @@ -24,8 +29,12 @@
      -
      +
      • »
        • @@ -194,9 +281,15 @@

        Source code for yfpy.models

                 """
         return json.dumps(self.serialized(), indent=2, default=complex_json_handler, ensure_ascii=False)
        - @classmethod +
        [docs] @classmethod def from_json(cls, json_data: Dict): - return cls(json_data)
        + """Deserialize JSON to a class object. + + Returns: + object: Class object derived from JSON data. + + """ + return cls(json_data)
      # noinspection DuplicatedCode, PyUnresolvedReferences @@ -211,8 +304,8 @@

      Source code for yfpy.models

                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            games (list of Game): List of Yahoo Fantasy games in which the user participates/has participated.
-            guid (str): Yahoo user ID.
+            games (list[Game]): The Yahoo Fantasy games in which the user participates/has participated.
+            guid (str): The Yahoo user ID.
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -232,23 +325,23 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            code (str): Yahoo Fantasy game code.
-            game_id (int): Yahoo Fantasy game ID.
-            game_key (str): Yahoo Fantasy game key.
-            game_weeks (list of GameWeek): Yahoo Fantasy GameWeek objects.
-            is_game_over (int): Numeric boolean (0 or 1) representing if the Yahoo Fantasy Game is complete.
+            code (str): The Yahoo Fantasy game code.
+            game_id (int): The Yahoo Fantasy game ID.
+            game_key (str): The Yahoo Fantasy game key.
+            game_weeks (list[GameWeek]): A list of YFPY GameWeek instances.
+            is_game_over (int): Numeric boolean (0 or 1) representing if the Yahoo Fantasy game is complete.
             is_live_draft_lobby_active (int): Numeric boolean (0 or 1) representing if the draft lobby is active.
             is_offseason (int): Numeric boolean (0 or 1) representing if it is the offseason for the respective sport.
             is_registration_over (int): Numeric boolean (0 or 1) representing registration for the fantasy game is over.
-            leagues (list of League): Yahoo Fantasy League objects.
-            name (str): Yahoo Fantasy game name.
-            position_types (list of PositionType): Yahoo Fantasy PositionType objects.
-            roster_positions (list of RosterPosition): Yahoo Fantasy RosterPosition objects.
-            season (int): Yahoo Fantasy game year.
-            stat_categories (StatCategories): Yahoo Fantasy StatCategories object.
-            teams (list of Team): Yahoo Fantasy Team objects.
-            type (str): Yahoo Fantasy game type.
-            url (str): Yahoo Fantasy game URL.
+            leagues (list[League]): A list of YFPY League instances.
+            name (str): The name of the Yahoo Fantasy game.
+            position_types (list[PositionType]): A list of YFPY PositionType instances.
+            roster_positions (list[RosterPosition]): A list of YFPY RosterPosition instances.
+            season (int): The Yahoo Fantasy game year.
+            stat_categories (StatCategories): A YFPY StatCategories instance.
+            teams (list[Team]): A list of YFPY Team instances.
+            type (str): The type of the Yahoo Fantasy game.
+            url (str): The direct URL of the Yahoo Fantasy game.
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -283,10 +376,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            display_name (str): Yahoo Fantasy GameWeek display name.
-            end (str): Yahoo Fantasy GameWeek end date.
-            start (str): Yahoo Fantasy GameWeek start date.
-            week (int): Yahoo Fantasy GameWeek week number.
+            display_name (str): The display name of the Yahoo Fantasy game week.
+            end (str): The end date of the Yahoo Fantasy game week.
+            start (str): The start date of the Yahoo Fantasy game week.
+            week (int): The week number of the Yahoo Fantasy game week.
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -308,8 +401,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            type (str):
-            display_name (str):
+            type (str): The type of the player position ("offense", "defense", etc.).
+            display_name (str): The full text display of the position type.
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -329,45 +422,50 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            allow_add_to_dl_extra_pos (int):
-            current_week (int):
-            draft_results (str):
-            draft_status (str):
-            display_name (str):
-            edit_key (int):
-            end_date (str):
-            end_week (int):
-            entry_fee (str):
-            game_code (str):
-            iris_group_chat_id (str):
-            is_cash_league (int):
-            is_finished (int):
-            is_pro_league (str):
-            league_id (str):
-            league_key (str):
-            league_type (str):
-            league_update_timestamp (int):
-            logo_url (str):
-            name (str):
-            num_teams (str):
-            password (str):
-            payment_deadline (str):
-            players (str):
-            renew (str):
-            renewed (str):
-            scoreboard (Scoreboard):
-            matchups (list of Matchup):
-            scoring_type (str):
-            season (int):
-            settings (Settings):
-            short_invitation_url (str):
-            standings (Standings):
-            teams_ordered_by_standings (list of Team):
-            start_date (str):
-            start_week (int):
-            transactions (list of Transaction):
-            url (str):
-            weekly_deadline (str):
+            allow_add_to_dl_extra_pos (int): Numeric boolean (0 or 1) representing if the leagues allows adding extra
+                positions to the DL (currently uncertain what this is).
+            current_week (int): The current week number.
+            draft_results (list[DraftResult]): A list of YFPY DraftResult instances.
+            draft_status (str): The status of the draft ("postdraft", etc.).
+            display_name (str): The display name of the league.
+            edit_key (int): The Yahoo edit key for the league.
+            end_date (str): A date string representing the end date of the league (format: "YYYY-MM-DD").
+            end_week (int): The number of the last week of the league.
+            entry_fee (str): The entry fee for Yahoo paid leagues (USD).
+            game_code (str): The Yahoo game code ("nfl", "nhl", "nba", "mlb").
+            iris_group_chat_id (str | null): The unique IRIS group chat ID for the league.
+            is_cash_league (int): Numeric boolean (0 or 1) representing if the league is a Yahoo paid league.
+            is_finished (int): Numeric boolean (0 or 1) representing if the league season has completed.
+            is_pro_league (str): Numeric boolean (0 or 1) representing if the league is a Yahoo Pro league.
+            league_id (str): The unique Yahoo league ID.
+            league_key (str): The Yahoo league key.
+            league_type (str): The type of the league ("private", "public").
+            league_update_timestamp (int): A timestamp representing the last time the league was updated.
+            logo_url (str): The direct URL of the league logo photo.
+            name (str): The name of the league.
+            num_teams (str): The number of teams in the league.
+            password (str | null): The password required to join the league (if applicable).
+            payment_deadline (str): A date string representing the deadline by which all league dues payments must be
+                made (format: "YYYY-MM-DD").
+            players (list[Player]): A list of YFPY Player instances.
+            renew (str | null): A string indicating the previous Yahoo game code and previous Yahoo league ID (Ex.:
+                "371_811308") (if applicable).
+            renewed (str | null): A string indicating the next Yahoo game code and next Yahoo league ID (Ex.:
+                "390_303233") (if applicable).
+            scoreboard (Scoreboard): A YFPY Scoreboard instance.
+            matchups (list[Matchup]): A list of YFPY Matchup instances.
+            scoring_type (str): The scoring type of the league ("head" for head-to-head, etc.).
+            season (int): The season year of the league.
+            settings (Settings): A YFPY Settings instance.
+            short_invitation_url (str): The sharable short URL sent by invite allowing players to join the league.
+            standings (Standings): A YFPY Standings instance.
+            teams_ordered_by_standings (list[Team]): A list of YFPY Team instances ordered by their ranks in the league
+                standings.
+            start_date (str): A date string representing the start date of the league (format: "YYYY-MM-DD").
+            start_week (int): The number of the first week of the league.
+            transactions (list[Transaction]): A list of YFPY Transaction instances.
+            url (str): The direct URL of the league.
+            weekly_deadline (str | null): The weekly deadline of the league (if applicable).
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -423,45 +521,48 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            clinched_playoffs (int):
-            division_id (str):
-            draft_grade (str):
-            draft_position (int):
-            draft_recap_url (str):
-            draft_results (list of DraftResult):
-            faab_balance (int):
-            has_draft_grade (int):
-            league_scoring_type (str):
-            managers (list of Manager | dict of str: Manager):
-            matchups (list of Matchup):
-            name (str):
-            number_of_moves (int):
-            number_of_trades (int):
-            roster (Roster):
-            players (list of Player):
-            roster_adds (RosterAdds):
-            roster_adds_value (int):
-            team_id (int):
-            team_key (str):
-            team_logos (list of TeamLogo):
-            team_points (TeamPoints):
-            points (float):
-            team_projected_points (TeamProjectedPoints):
-            projected_points (float):
-            team_standings (TeamStandings):
-            wins (int):
-            losses (int):
-            ties (int):
-            percentage (float):
-            playoff_seed (int):
-            points_against (float):
-            points_for (float):
-            rank (int):
-            streak_type (str):
-            streak_length (int):
-            url (str):
-            waiver_priority (int):
-            win_probability (float):
+            clinched_playoffs (int): Numeric boolean (0 or 1) representing if the team has clinched a playoff berth.
+            division_id (str): The unique ID number of the division containing the team (if applicable).
+            draft_grade (str): The letter grade assigned to the draft completed by the team ("A+", "A", ..., "F-").
+            draft_position (int): The draft order/position of the team.
+            draft_recap_url (str): The direct URL of the draft recap for the team.
+            draft_results (list[DraftResult]): A list of YFPY DraftResult instances.
+            faab_balance (int): The available balance of FAAB (Free Agent Acquisition Budget) (if applicable).
+            has_draft_grade (int): Numeric boolean (0 or 1) representing if the team has a draft grade available.
+            league_scoring_type (str): Value designating the type of scoring used by the league ("head" for
+                head-to-head, etc.).
+            managers (list[Manager] | dict[str, Manager]): A list or dict (depending on source data) of YFPY Manager
+                instances.
+            matchups (list[Matchup]): A list of YFPY Matchup instances.
+            name (str): The team name.
+            number_of_moves (int): The number of moves made by the team (adds/drops/trades/etc.).
+            number_of_trades (int): The number of trades made by the team.
+            roster (Roster): A YFPY Roster instance.
+            players (list[Player]): A list of YFPY Player instances.
+            roster_adds (RosterAdds): A YFPY RosterAdds instance.
+            roster_adds_value (int): The number of roster adds made by the team.
+            team_id (int): The unique team ID in the league.
+            team_key (str): The Yahoo team key.
+            team_logos (list[TeamLogo]): A list of YFPY TeamLogo instances.
+            team_points (TeamPoints): A YFPY TeamPoints instance.
+            points (float): The total points scored by the team.
+            team_projected_points (TeamProjectedPoints): A YFPY TeamProjectedPoints instance.
+            projected_points (float): The total projected points for the team.
+            team_standings (TeamStandings): A YFPY TeamStandings instance.
+            wins (int): The number of wins by the team.
+            losses (int): The number of losses by the team.
+            ties (int): The number of ties by the team.
+            percentage (float): The win percentage of the team.
+            playoff_seed (int): The playoff seed of the team.
+            points_against (float): The total team points against.
+            points_for (float): The total team points for.
+            rank (int): The rank of the team in the league standings.
+            streak_type (str): The active team win/loss/tie streak.
+            streak_length (int): The length of the streak.
+            url (str): The direct URL to the team.
+            waiver_priority (int): The waiver priority of the team.
+            win_probability (float): The active win probability of the team in its current matchup (ranges from 0.0 to
+                1.0).
 
         """
         YahooFantasyObject.__init__(self, extracted_data)
@@ -519,10 +620,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            pick (int):
-            round (int):
-            team_key (str):
-            player_key (str):
+            pick (int): The draft pick number.
+            round (int): The draft round.
+            team_key (str): The Yahoo team key of the team that made the draft pick.
+            player_key (str): The Yahoo player key of the player that was drafted.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.pick = self.extracted_data.get("pick", 0)
@@ -531,7 +632,7 @@ 
      Source code for yfpy.models
               self.player_key = self.extracted_data.get("player_key", "")
      
 
 
-# noinspection PyUnresolvedReferences
+# noinspection PyUnresolvedReferences,GrazieInspection
 
      [docs]class Standings(YahooFantasyObject):
     """Model class for "standings" data key.
     """
@@ -543,7 +644,7 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            teams (list of Team):
+            teams (list[Team]): A list of YFPY Team instances with standings data.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.teams = self.extracted_data.get("teams", [])
      
@@ -561,16 +662,16 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            players (list of Player):
-            status (str):
-            timestamp (int):
-            tradee_team_key (str):
-            tradee_team_name (str):
-            trader_team_key (str):
-            trader_team_name (str):
-            transaction_id (int):
-            transaction_key (str):
-            type (str):
+            players (list[Player]): A list of YFPY Player instances.
+            status (str): The transaction status ("successful", etc.).
+            timestamp (int): The timestamp of when the transaction occurred.
+            tradee_team_key (str): The Yahoo team key for the team receiving the player (if applicable).
+            tradee_team_name (str): The team name of the team receiving the player (if applicable).
+            trader_team_key (str): The Yahoo team key for the team sending the player (if applicable).
+            trader_team_name (str): The team name for the team sending the player (if applicable).
+            transaction_id (int): The unique transaction ID number.
+            transaction_key (str): The Yahoo transaction key (Ex.: "406.l.413954.tr.555").
+            type (str): The type of the transaction ("add", "drop", "trade", etc.).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.players = self.extracted_data.get("players", [])
@@ -597,12 +698,12 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            email (str):
-            guid (str):
-            image_url (str):
-            is_comanager (int):
-            manager_id (int):
-            nickname (str):
+            email (str): The email address of the manager.
+            guid (str): The unique Yahoo GUID of the user account associated with manager.
+            image_url (str): The direct URL of the manager profile image.
+            is_comanager (int): Numeric boolean (0 or 1) representing if the manager is a co-manager.
+            manager_id (int): The unique manager ID in the league.
+            nickname (str): The display nickname of the manager.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.email = self.extracted_data.get("email", "")
@@ -625,10 +726,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            week (int):
-            is_editable (int):
-            players (list of Player):
+            coverage_type (str): The timeframe for the selected roster ("week", "date", "season", etc.).
+            week (int): The week number.
+            is_editable (int): Numeric boolean (0 or 1) representing if the roster is editable.
+            players (list[Player]): A list of YFPY Player instances.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -649,9 +750,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            coverage_value (int):
-            value (int):
+            coverage_type (str): The timeframe for the selected roster ("week", "date", "season", etc.).
+            coverage_value (int): The value of the coverage type (week number, for instance).
+            value (int): The number of roster adds within the coverage timeframe.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -671,8 +772,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            size (str):
-            url (str):
+            size (str): The size of the team logo photo ("small", "large", etc.)
+            url (str): The direct URL of the team logo photo.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.size = self.extracted_data.get("size", "")
@@ -691,10 +792,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            season (int):
-            total (float):
-            week (int):
+            coverage_type (str): The timeframe for the selected team points ("week", "date", "season", etc.).
+            season (int): The season year.
+            total (float): The total team points for the coverage timeframe.
+            week (int): The week number (if applicable).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -715,9 +816,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            total (float):
-            week (int):
+            coverage_type (str): The timeframe for the selected team projected points ("week", "date", "season", etc.).
+            total (float): The total team projected points for the coverage timeframe.
+            week (int): The week number.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -737,13 +838,13 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            divisional_outcome_totals (DivisionalOutcomeTotals):
-            outcome_totals (OutcomeTotals):
-            playoff_seed (int):
-            points_against (float):
-            points_for (float):
-            rank (int):
-            streak (Streak):
+            divisional_outcome_totals (DivisionalOutcomeTotals): A list of YFPY DivisionalOutcomeTotals instances.
+            outcome_totals (OutcomeTotals): A YFPY OutcomeTotals instance.
+            playoff_seed (int): The playoff seed position for the team.
+            points_against (float): The total team points against.
+            points_for (float): The total team points for.
+            rank (int): The rank of the team in the league standings.
+            streak (Streak): A YFPY Streak instance.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.divisional_outcome_totals = self.extracted_data.get(
@@ -768,9 +869,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            losses (int):
-            ties (int):
-            wins (int):
+            losses (int): The number of losses by the team within the division.
+            ties (int): The number of ties by the team within the division.
+            wins (int): The number of wins by the team within the division.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.losses = int(self.extracted_data.get("losses", 0) or 0)
@@ -790,10 +891,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            losses (int):
-            percentage (float):
-            ties (int):
-            wins (int):
+            losses (int): The number of losses by the team.
+            percentage (float): The win percentage of the team.
+            ties (int): The number of ties by the team.
+            wins (int): The number of wins by the team.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.losses = int(self.extracted_data.get("losses", 0) or 0)
@@ -814,8 +915,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            type (str):
-            value (int):
+            type (str): The streak type ("W" for win, "L" for loss, "T" for tie).
+            value (int): The length of the streak.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.type = self.extracted_data.get("type", "")
@@ -834,8 +935,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            week (int):
-            matchups (list of Matchup):
+            week (int): The week for which the scoreboard applies.
+            matchups (list[Matchup]): A list of YFPY Matchup instances representing the matchups for the week.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.week = self.extracted_data.get("week", 0)
@@ -854,37 +955,43 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            cant_cut_list (str):
-            divisions (int):
-            draft_pick_time (int):
-            draft_time (int):
-            draft_type (str):
-            has_multiweek_championship (int):
-            has_playoff_consolation_games (bool):
-            is_auction_draft (int):
-            max_teams (int):
-            num_playoff_consolation_games (int):
-            num_playoff_teams (int):
-            pickem_enabled (int):
-            player_pool (str):
-            playoff_start_week (int):
-            post_draft_players (str):
-            roster_positions (list of RosterPosition):
-            scoring_type (str):
-            stat_categories (StatCategories):
-            stat_modifiers (StatModifiers):
-            trade_end_date (str):
-            trade_ratify_type (str):
-            trade_reject_time (int):
-            uses_faab (int):
-            uses_fractional_points (int):
-            uses_lock_eliminated_teams (int):
-            uses_negative_points (int):
-            uses_playoffs (int):
-            uses_playoff_reseeding (int):
-            waiver_rule (str):
-            waiver_time (int):
-            waiver_type (str):
+            cant_cut_list (str): Numeric boolean (0 or 1) representing if the league uses the Yahoo "can't cut list".
+            divisions (int): Numeric boolean (0 or 1) representing if the league has divisions.
+            draft_pick_time (int): The number of seconds allowed to make each draft pick.
+            draft_time (int): A timestamp representing when the draft will start.
+            draft_type (str): The type of draft ("live", "offline", etc.)
+            has_multiweek_championship (int): Numeric boolean (0 or 1) representing if the league has a multi-week
+                championship matchup.
+            has_playoff_consolation_games (bool): Numeric boolean (0 or 1) representing if the league has a consolation
+                playoff bracket.
+            is_auction_draft (int): Numeric boolean (0 or 1) representing if the league uses an auction draft.
+            max_teams (int): The maximum number of teams allowed in the league.
+            num_playoff_consolation_teams (int): The number of teams that make the consolation playoff bracket.
+            num_playoff_teams (int): The number of teams that make the playoffs.
+            pickem_enabled (int): Numeric boolean (0 or 1) representing if the league has enabled the built-in Yahoo
+                "pick 'em" game that allows managers to pick winners of each fantasy matchup each week in the league.
+            player_pool (str): Value designating what player pool is allowed for the league ("ALL", etc.).
+            playoff_start_week (int): The week number on which the playoffs start.
+            post_draft_players (str): Value designating what happens to players after the draft ("W" for waivers, etc.).
+            roster_positions (list[RosterPosition]): A list of YFPY RosterPosition instances.
+            scoring_type (str): Value designating what type of scoring the league uses ("head" for head-to-head, etc.).
+            stat_categories (StatCategories): A YFPY StatCategories instance.
+            stat_modifiers (StatModifiers): A YFPY StatModifiers instance.
+            trade_end_date (str): A date string representing when trading is no longer allowed (format: "YYYY-MM-DD").
+            trade_ratify_type (str): Value designating how trades are ratified ("commish" for commissioner, etc.).
+            trade_reject_time (int): The number of days during which a trade can be rejected.
+            uses_faab (int): Numeric boolean (0 or 1) representing if the league uses FAAB (Free Agent Acquisition
+                Budget).
+            uses_fractional_points (int): Numeric boolean (0 or 1) representing if the league allows fractional scoring.
+            uses_lock_eliminated_teams (int): Numeric boolean (0 or 1) representing if the league locks teams
+                eliminated from the playoffs.
+            uses_negative_points (int): Numeric boolean (0 or 1) representing if the league allows negative scoring.
+            uses_playoffs (int): Numeric boolean (0 or 1) representing if the league has playoffs.
+            uses_playoff_reseeding (int): Numeric boolean (0 or 1) representing if the league reseeds the playoffs once
+                the fantasy regular season is complete.
+            waiver_rule (str): Value designating when players go to waivers ("gametime", etc.).
+            waiver_time (int): The number of days that players remain on waivers.
+            waiver_type (str): Value designating what type of waivers are used by the league ("R" for rolling, etc.).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.cant_cut_list = self.extracted_data.get("cant_cut_list", "")
@@ -932,8 +1039,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            division_id (int):
-            name (str):
+            division_id (int): The unique division ID number in the league.
+            name (str): The division name.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.division_id = self.extracted_data.get("division_id", 0)
@@ -952,9 +1059,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            count (int):
-            position (str):
-            position_type (str):
+            count (int): The number of roster slots available for this position.
+            position (str): The position string.
+            position_type (str): The position type ("O" for offense, etc.)
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.count = self.extracted_data.get("count", 0)
@@ -974,7 +1081,7 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            stats (list of Stat):
+            stats (list[Stat]): A list of YFPY Stat instances representing the league stat categories.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.stats = self.extracted_data.get("stats", [])
      
@@ -992,7 +1099,7 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            stats (list of Stat):
+            stats (list[Stat]): A list of YFPY Stat instances containing modifiers for each stat category.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.stats = self.extracted_data.get("stats", [])
      
@@ -1010,15 +1117,16 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            bonuses (list of Bonus):
-            display_name (str):
-            enabled (int):
-            name (str):
-            position_type (str):
-            sort_order (int):
-            stat_id (int):
-            stat_position_types (list of PositionType):
-            value (float):
+            bonuses (list[Bonus]): A list of YFPY Bonus instances available for this stat category.
+            display_name (str): The abbreviated display name of the stat.
+            enabled (int): Numeric boolean (0 or 1) representing if this stat is enabled for league scoring.
+            name (str): The full name of the stat.
+            position_type (str): The player position type eligible for the stat.
+            sort_order (int): Numeric boolean (0 or 1) representing if the stat is sorted highest to lowest (1) or
+                lowest to highest (0).
+            stat_id (int): The unique stat ID number in the league.
+            stat_position_types (list[PositionType]): A list of YFPY PositionType instances.
+            value (float): The value of the stat (if applicable).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.bonuses = self.extracted_data.get("bonuses", [])
@@ -1029,7 +1137,10 @@ 
      Source code for yfpy.models
               self.sort_order = self.extracted_data.get("sort_order", 0)
         self.stat_id = self.extracted_data.get("stat_id", 0)
         self.stat_position_types = self.extracted_data.get("stat_position_types", [])
-        self.value = float(self.extracted_data.get("value", 0) or 0)
      
+        try:
+            self.value = float(self.extracted_data.get("value", 0) or 0)
+        except ValueError:
+            self.value = 0.0
      
 
 
 # noinspection PyUnresolvedReferences
@@ -1044,8 +1155,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            is_only_display_stat (int):
-            position_type (str):
+            is_only_display_stat (int): Numeric boolean (0 or 1) representing if the stat is only for display (such as
+                if it is just the player position string).
+            position_type (str): The type of the position ("O" for offense, etc.)
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.is_only_display_stat = self.extracted_data.get("is_only_display_stat", 0)
@@ -1064,8 +1176,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            points (int):
-            target (int):
+            points (int): The points awarded when the bonus is won.
+            target (int): The stat value target required to be awarded the bonus.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.points = self.extracted_data.get("points", 0)
@@ -1084,19 +1196,19 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            is_consolation (int):
-            is_matchup_recap_available (int):
-            is_playoffs (int):
-            is_tied (int):
-            matchup_grades (list of MatchupGrade):
-            matchup_recap_title (str):
-            matchup_recap_url (str):
-            status (str):
-            teams (list of Team):
-            week (int):
-            week_end (str):
-            week_start (str):
-            winner_team_key (str):
+            is_consolation (int): Numeric boolean (0 or 1) representing if the matchup is in a consolation bracket.
+            is_matchup_recap_available (int): Numeric boolean (0 or 1) representing if the matchup recap is available.
+            is_playoffs (int): Numeric boolean (0 or 1) representing if the matchup is in the playoffs bracket.
+            is_tied (int): Numeric boolean (0 or 1) representing if the matchup result is tied.
+            matchup_grades (list[MatchupGrade]): A list of YFPY MatchupGrade instances.
+            matchup_recap_title (str): The title of the matchup recap.
+            matchup_recap_url (str): The direct URL of the matchup recap.
+            status (str): The status of the matchup ("postevent", etc.).
+            teams (list[Team]): A list of YFPY Team instances for teams in the matchup.
+            week (int): The week number of the matchup.
+            week_end (str): A date string representing the end of the matchup week (format: "YYYY-MM-DD").
+            week_start (str): A date string representing the start of the matchup week (format: "YYYY-MM-DD").
+            winner_team_key (str): The Yahoo team key of the team that won the matchup.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.is_consolation = self.extracted_data.get("is_consolation", 0)
@@ -1126,8 +1238,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            grade (str):
-            team_key (str):
+            grade (str): The letter grade assigned to the matchup performance ("A+", "A", ..., "F-").
+            team_key (str): The Yahoo team key for the team receiving the matchup grade.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.grade = self.extracted_data.get("grade", "")
@@ -1146,46 +1258,46 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            bye_weeks (ByeWeeks):
-            bye (int):
-            display_position (str):
-            draft_analysis (DraftAnalysis):
-            average_draft_pick (float):
-            average_draft_round (float):
-            average_draft_cost (float):
-            percent_drafted (float):
-            editorial_player_key (str):
-            editorial_team_abbr (str):
-            editorial_team_full_name (str):
-            editorial_team_key (str):
-            eligible_positions (list of str):
-            has_player_notes (int):
-            headshot (Headshot):
-            headshot_size (str):
-            headshot_url (str):
-            is_editable (int):
-            is_undroppable (int):
-            name (Name):
-            first_name (str):
-            last_name (str):
-            full_name (str):
-            ownership (Ownership):
-            percent_owned (PercentOwned):
-            percent_owned_value (float):
-            player_id (int):
-            player_key (str):
-            player_notes_last_timestamp (int):
-            player_points (PlayerPoints):
-            player_points_value (float):
-            player_stats (PlayerStats):
-            stats (list of Stat):
-            position_type (str):
-            primary_position (str):
-            selected_position (SelectedPosition):
-            selected_position_value (str):
-            status (str):
-            transaction_data (TransactionData):
-            uniform_number (int):
+            bye_weeks (ByeWeeks): A YFPY ByeWeeks instance.
+            bye (int): The week number that the player is on bye.
+            display_position (str): The display string for the player position.
+            draft_analysis (DraftAnalysis): A YFPY DraftAnalysis instance.
+            average_draft_pick (float): The average pick at which the player was drafted.
+            average_draft_round (float): The average round in which the player was drafted.
+            average_draft_cost (float): The average price paid for the player to be drafted.
+            percent_drafted (float): The overall percentage the player was drafted.
+            editorial_player_key (str): The Yahoo player key using the game key.
+            editorial_team_abbr (str): The abbreviation of the professional team name for which the player plays.
+            editorial_team_full_name (str): The name of the professional team for which the player plays.
+            editorial_team_key (str): The Yahoo team key using the game key.
+            eligible_positions (list[str]): A list of positions for which the player is eligible.
+            has_player_notes (int): Numeric boolean (0 or 1) representing if the player has any notes.
+            headshot (Headshot): A YFPY Headshot instance.
+            headshot_size (str): The headshot photo size ("small", "large", etc.)
+            headshot_url (str): The direct URL of the headshot photo.
+            is_editable (int): Numeric boolean (0 or 1) representing if the player is editable.
+            is_undroppable (int): Numeric boolean (0 or 1) representing if the player is undroppable.
+            name (Name): A YFPY Name instance.
+            first_name (str): The first name of the player.
+            last_name (str): The last name of the player.
+            full_name (str): The full name of the player.
+            ownership (Ownership): A YFPY Ownership instance.
+            percent_owned (PercentOwned): A YFPY PercentOwned instanced.
+            percent_owned_value (float): The percentage value the player is/was owned in the coverage timeframe.
+            player_id (int): The unique player ID.
+            player_key (str): The Yahoo player key.
+            player_notes_last_timestamp (int): A timestamp of the most recent players notes.
+            player_points (PlayerPoints): A YFPY PlayerPoints instance.
+            player_points_value (float): The total points for the player within the coverage timeframe.
+            player_stats (PlayerStats): A YFPY PlayerStats instance.
+            stats (list[Stat]): A list of YFPY Stat instances.
+            position_type (str): The position type of the player ("offense", "defense", etc.).
+            primary_position (str): The primary position of the player.
+            selected_position (SelectedPosition): A YFPY SelectedPosition instance.
+            selected_position_value (str): The selected position of the player.
+            status (str): The status of the player ("IR", "PUP", "O", "Q", etc.).
+            transaction_data (TransactionData): A YFPY TransactionData instance.
+            uniform_number (int): The uniform number of the player.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.bye_weeks = self.extracted_data.get("bye_weeks", ByeWeeks({}))  # type: ByeWeeks
@@ -1255,7 +1367,7 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            week (int):
+            week (int): The week number that the player is on bye.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.week = self.extracted_data.get("week", 0)
      
@@ -1273,10 +1385,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            average_pick (float):
-            average_round (float):
-            average_cost (float):
-            percent_drafted (float):
+            average_pick (float): The average pick at which the player was drafted.
+            average_round (float): The average round in which the player was drafted.
+            average_cost (float): The average price paid for the player to be drafted.
+            percent_drafted (float): The overall percentage the player was drafted.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         try:
@@ -1309,8 +1421,8 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            size (str):
-            url (str):
+            size (str): The size of the headshot photo ("small", "large", etc.)
+            url (str): The direct URL of the headshot photo.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.size = self.extracted_data.get("size", "")
@@ -1329,11 +1441,11 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            ascii_first (str):
-            ascii_last (str):
-            first (str):
-            full (str):
-            last (str):
+            ascii_first (str): The ASCII encoded string of the first name of the player.
+            ascii_last (str): The ASCII encoded string of the last name of the player.
+            first (str): The first name of the player.
+            full (str): The full name of the player.
+            last (str): The last name of teh player.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.ascii_first = self.extracted_data.get("ascii_first", "")
@@ -1355,10 +1467,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            ownership_type (str):
-            owner_team_key (str):
-            owner_team_name (str):
-            teams (list of Team):
+            ownership_type (str): The current location of the player in the league ("team", "waivers", etc.).
+            owner_team_key (str): The Yahoo team key for the team that owns the player.
+            owner_team_name (str): The team name for the team that owns the player.
+            teams (list[Team]): A list of YFPY Team instances.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.ownership_type = self.extracted_data.get("ownership_type", "")
@@ -1379,10 +1491,11 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            week (int):
-            value (int):
-            delta (float):
+            coverage_type (str): The timeframe for the selected player ownership ("week", "date", "season", etc.).
+            week (int): The week number (when applicable).
+            value (int): The percentage value the player is/was owned in the coverage timeframe.
+            delta (float): The change in the percentage value from the previous coverage timeframe to the current
+                coverage timeframe.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -1403,9 +1516,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            week (int):
-            total (float):
+            coverage_type (str): The timeframe for the selected player points ("week", "date", "season", etc.).
+            week (int): The week number (when applicable).
+            total (float): The total points for the player within the coverage timeframe.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -1425,9 +1538,9 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            week (int):
-            stats (list of Stat):
+            coverage_type (str): The timeframe for the selected player stats ("week", "date", "season", etc.).
+            week (int): The week number (when applicable).
+            stats (list[Stat]): A list of YFPY Stat instances for the player.
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -1447,10 +1560,10 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            coverage_type (str):
-            is_flex (int):
-            position (str):
-            week (int):
+            coverage_type (str): The timeframe for the selected position ("week", "date", "season", etc.).
+            is_flex (int): Numeric boolean (0 or 1) representing if the selected player is in a flex roster slot.
+            position (str): The selected position of the player.
+            week (int): The week number (when applicable).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.coverage_type = self.extracted_data.get("coverage_type", "")
@@ -1471,13 +1584,13 @@ 
      Source code for yfpy.models
                   extracted_data (dict): Parsed and cleaned JSON data retrieved from the Yahoo Fantasy Sports REST API.
 
         Attributes:
-            destination_team_key (str):
-            destination_team_name (str):
-            destination_type (str):
-            source_team_key (str):
-            source_team_name (str):
-            source_type (str):
-            type (str):
+            destination_team_key (str): The Yahoo team key for the receiving team.
+            destination_team_name (str): The name of the receiving team.
+            destination_type (str): The destination of the player (waivers, free agency, another team, etc.).
+            source_team_key (str): The Yahoo team key of the sending team.
+            source_team_name (str): The name of the sending team.
+            source_type (str): The origin of the player (waivers, free agency, another team, etc.).
+            type (str): The type of the transaction ("add", "drop", "trade", etc.).
         """
         YahooFantasyObject.__init__(self, extracted_data)
         self.destination_team_key = self.extracted_data.get("destination_team_key", "")
diff --git a/docs/_modules/yfpy/query.html b/docs/_modules/yfpy/query.html
index 51016ed7..2e0b56ee 100644
--- a/docs/_modules/yfpy/query.html
+++ b/docs/_modules/yfpy/query.html
@@ -3,9 +3,12 @@
 
   
   
-  yfpy.query — YFPY v6.0.0 documentation
+  yfpy.query — YFPY v7.0.2 documentation
       
       
+      
+      
+      
   
@@ -14,6 +17,8 @@
         
         
         
+        
+        
     
     
      
@@ -115,20 +120,22 @@ 
      Source code for yfpy.query
                   auth_dir (Path | str): Location of both private.json (containing Yahoo dev app consumer_key and
                 consumer_secret) and token.json (generated by OAuth2 three-legged handshake).
             league_id (str): League ID of selected Yahoo Fantasy league.
-            game_id (int, optional): Game ID of selected Yahoo fantasy game corresponding to a specific year, and
+            game_id (:obj:`int`, optional): Game ID of selected Yahoo fantasy game corresponding to a specific year, and
                 defaulting to the current year.
-            game_code (str, optional): Game code of selected Yahoo Fantasy game corresponding to a specific year, and
-                defaulting to "nfl" (fantasy football), "nhl" (fantasy hockey), "mlb" (fantasy baseball), or "nba"
+            game_code (:obj:`str`, optional): Game code of selected Yahoo Fantasy game corresponding to a specific year,
+                and defaulting to "nfl" (fantasy football), "nhl" (fantasy hockey), "mlb" (fantasy baseball), or "nba"
                 (fantasy basketball)
-            offline (bool, optional): Boolean to run in offline mode (Only works if all needed Yahoo Fantasy data has
-                been previously saved locally using the Data module in data.py).
-            all_output_as_json (bool, optional): Option to automatically convert all query output to JSON strings.
-            consumer_key (str, optional): User defined consumer key to use instead of values stored in the private.json
-                file (must be defined alongside a user defined consumer secret).
-            consumer_secret (str, optional): User defined consumer secret to use instead of values stored in the
+            offline (:obj:`bool`, optional): Boolean to run in offline mode (Only works if all needed Yahoo Fantasy data
+                has been previously saved locally using the Data module in data.py).
+            all_output_as_json (:obj:`bool`, optional): Option to automatically convert all query output to JSON
+                strings.
+            consumer_key (:obj:`str`, optional): User defined consumer key to use instead of values stored in the
+                private.json file (must be defined alongside a user defined consumer secret).
+            consumer_secret (:obj:`str`, optional): User defined consumer secret to use instead of values stored in the
                 private.json file (must be defined alongside a user defined consumer key).
-            browser_callback (bool, optional): Enable or disable (enabled by default) whether the yahoo-oauth library
-                automatically opens a browser window to authenticate (if disabled, it will output the callback URL).
+            browser_callback (:obj:`bool`, optional): Enable or disable (enabled by default) whether the yahoo-oauth
+                library automatically opens a browser window to authenticate (if disabled, it will output the callback
+                URL).
 
         Attributes:
             _auth_dir (Path): Location of both private.json (containing Yahoo dev app consumer_key and consumer_secret)
@@ -153,7 +160,7 @@ 
      Source code for yfpy.query
                       previously saved locally using the Data module in data.py).
             all_output_as_json (bool): Option to automatically convert all query output to JSON strings.
             league_key (str): The Yahoo Fantasy Sports league key formatted as <game_id>.l.<league_id>.
-            executed_queries (list of dict of str: Any): List of completed queries and their responses.
+            executed_queries (list[dict[str, Any]]): List of completed queries and their responses.
 
         """
         self._auth_dir = auth_dir if type(auth_dir) == PosixPath else Path(auth_dir)  # type: Path
@@ -225,9 +232,9 @@ 
      Source code for yfpy.query
       
         Args:
             url (str): REST API request URL string.
-            retries (int, optional): Number of times to retry a query if it fails (defaults to 3).
-            backoff (int, optional): Multiplier that incrementally increases the wait time before retrying a failed
-                query request.
+            retries (:obj:`int`, optional): Number of times to retry a query if it fails (defaults to 3).
+            backoff (:obj:`int`, optional): Multiplier that incrementally increases the wait time before retrying a
+                failed query request.
 
         Returns:
             Response: API response from Yahoo Fantasy Sports API request.
@@ -301,15 +308,16 @@ 
      Source code for yfpy.query
       
         Args:
             url (str): REST API request URL string.
-            data_key_list (list of str | list of list of str): List of keys used to extract the specific data desired
-                by the given query (supports strings and lists of strings). Usage is as follows:
-                List containing only key strings: ["game", "stat_categories"]
-                List containing key strings and lists of key strings: ["team", ["team_points", "team_projected_points"]]
-            data_type_class (Type, optional): Highest level data model type (if one exists for the retrieved data).
+            data_key_list (list[str] | list[list[str]]): List of keys used to extract the specific data desired by the
+                given query (supports strings and lists of strings). Supports lists containing only key strings such as
+                ["game", "stat_categories"], and also supports lists containing key strings and lists of key strings
+                such as ["team", ["team_points", "team_projected_points"]].
+            data_type_class (:obj:`Type`, optional): Highest level data model type (if one exists for the retrieved
+                data).
 
         Returns:
-            Model class instance from yfpy/models.py, dictionary, or list (depending on query), with unpacked and parsed
-                response data.
+            object: Model class instance from yfpy/models.py, dictionary, or list (depending on query), with unpacked
+            and parsed response data.
 
         """
         if not self.offline:
@@ -389,7 +397,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Game instances.
+            list[Game]: List of YFPY Game instances.
 
         """
         return sorted(
@@ -660,7 +668,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY GameWeek instances.
+            list[GameWeek]: List of YFPY GameWeek instances.
 
         """
         return self.query(
@@ -746,7 +754,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY PositionType instances.
+            list[PositionType]: List of YFPY PositionType instances.
 
         """
         return sorted(
@@ -782,7 +790,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY RosterPosition instances.
+            list[RosterPosition]: List of YFPY RosterPosition instances.
 
         """
         return sorted(
@@ -865,7 +873,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Game instances.
+            list[Game]: List of YFPY Game instances.
 
         """
         return sorted(
@@ -921,7 +929,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY League instances.
+            list[League]: List of YFPY League instances.
 
         """
         leagues = self.query(
@@ -998,7 +1006,7 @@ 
      Source code for yfpy.query
                 ]
 
         Returns:
-            list: List of YFPY Game instances with "teams" field containing list of YFPY Team instances.
+            list[Game]: List of YFPY Game instances with "teams" field containing list of YFPY Team instances.
 
         """
         return sorted(
@@ -1328,7 +1336,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Team instances.
+            list[Team]: List of YFPY Team instances.
 
         """
         return self.query(
@@ -1390,7 +1398,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Player instances.
+            list[Player]: List of YFPY Player instances.
 
         """
         league_player_count = player_count_start
@@ -1488,7 +1496,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY DraftResult instances.
+            list[DraftResult]: List of YFPY DraftResult instances.
 
         """
         return self.query(
@@ -1541,7 +1549,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Transaction instances.
+            list[Transaction]: List of YFPY Transaction instances.
 
         """
         return self.query(
@@ -1675,7 +1683,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Matchup instances.
+            list[Matchup]: List of YFPY Matchup instances.
 
         """
         return self.query(
@@ -1688,7 +1696,7 @@ 
      Source code for yfpy.query
               """Retrieve info of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -1774,7 +1782,7 @@ 
      Source code for yfpy.query
               """Retrieve metadata of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -1829,7 +1837,7 @@ 
      Source code for yfpy.query
               """Retrieve stats of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -1857,7 +1865,7 @@ 
      Source code for yfpy.query
               """Retrieve stats of specific team by team_id and by week for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
             chosen_week (int): Selected week for which to retrieve data.
 
@@ -1878,8 +1886,8 @@ 
      Source code for yfpy.query
                   }
 
         Returns:
-            dict: Dictionary containing both a YFPY TeamPoints instance and a YFPY TeamProjectedPoints instance with
-                respective keys "team_points" and "team_projected_points".
+            dict[str, TeamPoints | TeamProjectedPoints]: Dictionary containing both a YFPY TeamPoints instance and a
+            YFPY TeamProjectedPoints instance with respective keys "team_points" and "team_projected_points".
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -1892,7 +1900,7 @@ 
      Source code for yfpy.query
               """Retrieve standings of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -1930,7 +1938,7 @@ 
      Source code for yfpy.query
               """Retrieve roster of specific team by team_id and by week for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
             chosen_week (int): Selected week for which to retrieve data.
 
@@ -2004,7 +2012,7 @@ 
      Source code for yfpy.query
               """Retrieve roster with ALL player info of specific team by team_id and by week for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
             chosen_week (int): Selected week for which to retrieve data.
 
@@ -2092,8 +2100,8 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Player instances containing the keys "draft_analysis", "ownership", "percent_owned", and
-                "player_stats", which each return instances of their respective YFPY objects.
+            list[Player]: List of YFPY Player instances containing the keys "draft_analysis", "ownership",
+            "percent_owned", and "player_stats", which each return instances of their respective YFPY objects.
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2106,23 +2114,93 @@ 
      Source code for yfpy.query
       
      [docs]    def get_team_roster_player_info_by_date(self, team_id: str, chosen_date: str = None) -> List[Player]:
         """Retrieve roster with ALL player info of specific team by team_id and by date for chosen league.
 
-        Note: This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.
-
-        Warning: This query will FAIL if you pass it an INVALID date string!
+        Note:
+            This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.
+            This query will FAIL if you pass it an INVALID date string!
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
             chosen_date (str): Selected date for which to retrieve data. REQUIRED FORMAT: YYYY-MM-DD (Ex. 2011-05-01)
 
         Examples:
             >>> query = YahooFantasySportsQuery(Path("/path/to/auth/directory"), league_id="######")
             >>> query.get_team_roster_player_info_by_date(1, "2011-05-01")
-            TODO: EXAMPLE
+            [
+              {
+                "player": {
+                  "display_position": "C",
+                  "draft_analysis": {
+                    "average_pick": 33.2,
+                    "average_round": 3.5,
+                    "average_cost": 39.2,
+                    "percent_drafted": 1.0
+                  },
+                  "editorial_player_key": "nhl.p.3981",
+                  "editorial_team_abbr": "Chi",
+                  "editorial_team_full_name": "Chicago Blackhawks",
+                  "editorial_team_key": "nhl.t.4",
+                  "eligible_positions": [
+                    "C",
+                    "F"
+                  ],
+                  "has_player_notes": 1,
+                  "headshot": {
+                    "size": "small",
+                    "url": "https://s.yimg.com/iu/api/res/1.2/tz.KOMoEiBDch6AJAGaUtg--~C/
+                    YXBwaWQ9eXNwb3J0cztjaD0yMzM2O2NyPTE7Y3c9MTc5MDtkeD04NTc7ZHk9MDtmaT11bGNyb3A7aD02MDtxPTEwMDt3PTQ2/https://s.yimg.com/xe/i/us/sp/v/nhl_cutout/players_l/11032021/3981.png"
+                  },
+                  "is_editable": 0,
+                  "is_undroppable": 0,
+                  "name": {
+                    "ascii_first": "Jonathan",
+                    "ascii_last": "Toews",
+                    "first": "Jonathan",
+                    "full": "Jonathan Toews",
+                    "last": "Toews"
+                  },
+                  "ownership": {
+                    "ownership_type": "team",
+                    "owner_team_key": "303.l.69624.t.2",
+                    "owner_team_name": "The Bateleurs"
+                  },
+                  "percent_owned": {
+                    "coverage_type": "week",
+                    "week": 25,
+                    "value": 98,
+                    "delta": -1.0
+                  },
+                  "player_id": 3981,
+                  "player_key": "303.p.3981",
+                  "player_notes_last_timestamp": 1651606838,
+                  "player_stats": {
+                    "coverage_type": "date",
+                    "stats": [
+                      {
+                        "stat": {
+                          "stat_id": 1,
+                          "value": 1.0
+                        }
+                      },
+                      ...
+                    ]
+                  },
+                  "position_type": "P",
+                  "primary_position": "C",
+                  "selected_position": {
+                    "coverage_type": "date",
+                    "is_flex": 0,
+                    "position": "C"
+                  },
+                  "uniform_number": 19
+                }
+              },
+              ...
+            ]
 
         Returns:
-            list: List of YFPY Player instances containing the keys "draft_analysis", "ownership", "percent_owned", and
-                "player_stats", which each return instances of their respective YFPY objects.
+            list[Player]: List of YFPY Player instances containing the keys "draft_analysis", "ownership",
+            "percent_owned", and "player_stats", which each return instances of their respective YFPY objects.
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2137,7 +2215,7 @@ 
      Source code for yfpy.query
               """Retrieve roster with ALL player info for the season of specific team by team_id and for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -2211,8 +2289,8 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Player instances containing the keys "draft_analysis", "ownership", "percent_owned", and
-                "player_stats", which each return instances of their respective YFPY objects.
+            list[Player]: List of YFPY Player instances containing the keys "draft_analysis", "ownership",
+            "percent_owned", and "player_stats", which each return instances of their respective YFPY objects.
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2226,7 +2304,7 @@ 
      Source code for yfpy.query
               """Retrieve roster with player stats of specific team by team_id and by week for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
             chosen_week (int): Selected week for which to retrieve data.
 
@@ -2298,7 +2376,8 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Player instances containing the "player_stats" key (returns a YFPY PlayerStats instance).
+            list[Player]: List of YFPY Player instances containing the "player_stats" key (returns a YFPY PlayerStats
+            instance).
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2311,7 +2390,7 @@ 
      Source code for yfpy.query
               """Retrieve draft results of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -2330,7 +2409,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY DraftResult instances.
+            list[DraftResult]: List of YFPY DraftResult instances.
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2343,7 +2422,7 @@ 
      Source code for yfpy.query
               """Retrieve matchups of specific team by team_id for chosen league.
 
         Args:
-            team_id (type): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
+            team_id (str): Selected team ID for which to retrieva data (can be integers 1 through n where n is the
                 number of teams in the league).
 
         Examples:
@@ -2358,7 +2437,7 @@ 
      Source code for yfpy.query
                   ]
 
         Returns:
-            list: List of YFPY Matchup instances.
+            list[Matchup]: List of YFPY Matchup instances.
 
         """
         team_key = self.get_league_key() + ".t." + str(team_id)
@@ -2515,9 +2594,9 @@ 
      Source code for yfpy.query
       
      [docs]    def get_player_stats_by_date(self, player_key: str, chosen_date: str = None) -> Player:
         """Retrieve player stats by player_key and by date for chosen league.
 
-        Note: This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.
-
-        Warning: This query will FAIL if you pass it an INVALID date string!
+        Note:
+            This applies to MLB, NBA, and NHL leagues, but does NOT apply to NFL leagues.
+            This query will FAIL if you pass it an INVALID date string!
 
         Args:
             player_key (str): The player key of chosen player (example: 331.p.7200 - <game_id>.p.<player_id>).
diff --git a/docs/_modules/yfpy/utils.html b/docs/_modules/yfpy/utils.html
index 4dad0889..77f49a6f 100644
--- a/docs/_modules/yfpy/utils.html
+++ b/docs/_modules/yfpy/utils.html
@@ -3,9 +3,12 @@
 
   
   
-  yfpy.utils — YFPY v6.0.0 documentation
+  yfpy.utils — YFPY v7.0.2 documentation
       
       
+      
+      
+      
   
@@ -14,6 +17,8 @@
         
         
         
+        
+        
     
     
      
@@ -93,7 +98,7 @@ 
      Source code for yfpy.utils
               data (str): Data formatted as a JSON string.
 
     Returns:
-        The return value. True for success, False otherwise.
+        str: JSON string that has been formatted with indents (two spaces).
 
     """
     return f"\n{json.dumps(data, indent=2, default=complex_json_handler, ensure_ascii=False)}\n"
      
@@ -108,7 +113,7 @@ 
      Source code for yfpy.utils
               parent_class (Type): Parent class type used to extract custom subclass type options for casting.
 
     Returns:
-        Recursively returns JSON objects until data is completely parsed, cleaned, and typed (where applicable).
+        Any: Recursively returns JSON objects until data is completely parsed, cleaned, and typed (where applicable).
 
     """
     # extract subclasses from parent class for typing
@@ -173,8 +178,8 @@ 
      Source code for yfpy.utils
               json_obj (Any): JSON object (typically a dictionary or list, but can also be a primitive).
 
     Returns:
-        The numeric representation of any JSON strings that can be represented as integers or floats, else the
-            original JSON object.
+        int | float | Any: The numeric representation of any JSON strings that can be represented as integers or floats,
+        else the original JSON object.
 
     """
     if type(json_obj) == str:
@@ -202,7 +207,7 @@ 
      Source code for yfpy.utils
                   and classes for casting as values.
 
     Returns:
-        A Python object (representing the original JSON object) that has been cast to the specified types.
+        object: A Python object (representing the original JSON object) that has been cast to the specified type.
 
     """
     for k, v in json_obj_dict.items():
@@ -216,11 +221,11 @@ 
      Source code for yfpy.utils
           """Recursive function to flatten JSON lists containing all disparate JSON dictionaries with no overlapping keys.
 
     Args:
-        json_obj_dict_list (list of dict of str: Any): List of JSON dictionaries.
+        json_obj_dict_list (list[dict[str, Any]]): List of JSON dictionaries.
         parent_class (Type): Parent class type used to extract custom subclass type options.
 
     Returns:
-        Returns a dictionary if the list was flattened, else a cleaned list if no flattening was needed.
+        dict | list: Returns a dictionary if the list was flattened, else a cleaned list if no flattening was needed.
 
     """
     # filter out empty lists and dicts but include when value = 0
@@ -253,8 +258,8 @@ 
      Source code for yfpy.utils
               json_obj (Any): JSON object (typically a dictionary or list, but can also be a primitive).
 
     Returns:
-        A list made from a flattened dictionary if json_obj was a dictionary, the original list if json_obj was a list,
-            or the original value if json_obj was a primitive.
+        list: A list made from a flattened dictionary if json_obj was a dictionary, the original list if json_obj was a
+        list, or the original value if json_obj was a primitive.
 
     """
     if isinstance(json_obj, dict):
@@ -273,7 +278,7 @@ 
      Source code for yfpy.utils
               json_obj (Any): JSON object (typically a dictionary or list, but can also be a primitive).
 
     Returns:
-        JSON dictionary/list/primitive with contents cast to Python objects.
+        dict | list | int | float | str | bool: JSON dictionary/list/primitive with contents cast to Python objects.
 
     """
     if isinstance(json_obj, dict):
@@ -289,10 +294,11 @@ 
      Source code for yfpy.utils
           """Function to convert a JSON dictionary to a list.
 
     Args:
-        json_dict (dict of str: Any): JSON dictionary.
+        json_dict (dict[str, Any]): JSON dictionary.
 
     Returns:
-        A list derived from a JSON dictionary, or the original dictionary if it does not contain dictionaries as values.
+        list: A list derived from a JSON dictionary, or the original dictionary if it does not contain dictionaries as
+        values.
 
     """
     first_key = list(json_dict.keys())[0]
@@ -317,7 +323,7 @@ 
      Source code for yfpy.utils
               val_to_key (str): Key used to sort the dictionaries contained in json_dict.
 
     Returns:
-        An ordered dictionary of dictionaries sorted by val_to_key.
+        dict[str, Any]: An ordered dictionary of dictionaries sorted by val_to_key.
 
     """
     out = {}
@@ -336,7 +342,7 @@ 
      Source code for yfpy.utils
               obj (Any): Unserializable Python object to be serialized into JSON.
 
     Returns:
-        Serializable version of the Python object.
+        Any: Serializable version of the Python object.
 
     """
     if hasattr(obj, "serialized"):
@@ -355,7 +361,7 @@ 
      Source code for yfpy.utils
               json_obj (Any): JSON object (typically a dictionary or list, but can also be a primitive) to be cleaned.
 
     Returns:
-        Reformatted JSON list derived from original JSON object.
+        Any: Reformatted JSON list derived from original JSON object.
 
     """
     if isinstance(json_obj[0], list):
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644
index 00000000..b1f26c47
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,8 @@
+
+span.sig-name.descname {
+    color: mediumblue !important;
+}
+
+html[data-theme='dark'] .theme-switcher {
+    box-shadow: 0 3px 14px 4px rgba(255, 255, 255, 0.62) !important;
+}
diff --git a/docs/_static/dark_mode_css/custom.css b/docs/_static/dark_mode_css/custom.css
new file mode 100644
index 00000000..989c2ada
--- /dev/null
+++ b/docs/_static/dark_mode_css/custom.css
@@ -0,0 +1,77 @@
+.wy-side-nav-search input[type='text'] {
+  border-radius: 3px;
+}
+
+input[type='color'],
+input[type='date'],
+input[type='datetime-local'],
+input[type='datetime'],
+input[type='email'],
+input[type='month'],
+input[type='number'],
+input[type='password'],
+input[type='search'],
+input[type='tel'],
+input[type='text'],
+input[type='time'],
+input[type='url'],
+input[type='week'] {
+  box-shadow: none;
+}
+
+.theme-switcher {
+  border-radius: 50%;
+  position: fixed;
+  right: 1.6em;
+  bottom: 1.4em;
+  z-index: 3;
+  border: none;
+  height: 2.2em;
+  width: 2.2em;
+  background-color: #fcfcfc;
+  font-size: 20px;
+  -webkit-box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.62);
+  box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.62);
+  color: #404040;
+  transition: all 0.3s ease-in-out;
+}
+
+.wy-nav-content a,
+.wy-nav-content a:visited {
+  color: #3091d1;
+}
+
+body,
+.wy-nav-content-wrap,
+.wy-nav-content,
+.section,
+.highlight,
+.rst-content div[class^='highlight'],
+.wy-nav-content a,
+.btn-neutral,
+.btn,
+footer,
+.wy-nav-side,
+.wy-menu-vertical li,
+.wy-menu-vertical a,
+.wy-side-nav-search .wy-dropdown,
+.wy-side-nav-search a,
+.wy-side-nav-search input,
+html.writer-html4 .rst-content dl:not(.docutils) > dt,
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  > dt,
+.rst-content code,
+.rst-content tt,
+html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt,
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  dl:not(.field-list)
+  > dt,
+code,
+.rst-content code.xref,
+.rst-content tt.xref {
+  transition: all 0.2s ease-in-out;
+}
diff --git a/docs/_static/dark_mode_css/dark.css b/docs/_static/dark_mode_css/dark.css
new file mode 100644
index 00000000..fb8802d7
--- /dev/null
+++ b/docs/_static/dark_mode_css/dark.css
@@ -0,0 +1,501 @@
+:root {
+  --dark-text-color: #c1c1c1;
+  --dark-link-color: #249ee8;
+}
+
+html[data-theme='dark'] body {
+  color: #bfbfbf;
+}
+
+html[data-theme='dark'] .wy-nav-content-wrap {
+  background-color: #101010;
+}
+
+html[data-theme='dark'] .wy-nav-content {
+  background-color: #141414;
+}
+
+html[data-theme='dark'] .section {
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'] .highlight {
+  background-color: #17181c;
+}
+
+html[data-theme='dark'] .highlight .nn {
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'] .highlight .nb {
+  color: #8bb8df;
+}
+
+html[data-theme='dark'] .highlight .kn,
+html[data-theme='dark'] .highlight .kc,
+html[data-theme='dark'] .highlight .k {
+  color: #41c2ea;
+}
+
+html[data-theme='dark'] .highlight .s1,
+html[data-theme='dark'] .highlight .s2 {
+  color: #b3e87f;
+}
+
+html[data-theme='dark'] .highlight .nt {
+  color: #ccb350;
+}
+
+html[data-theme='dark'] .highlight .c1 {
+  color: #686868;
+}
+
+html[data-theme='dark'] .rst-content div[class^='highlight'] {
+  border-color: #1a1a1a;
+}
+
+html[data-theme='dark'] .wy-nav-content a,
+html[data-theme='dark'] .wy-nav-content a:visited {
+  color: var(--dark-link-color);
+}
+
+html[data-theme='dark'] .btn-neutral {
+  background-color: #17181c !important;
+}
+
+html[data-theme='dark'] .btn-neutral:hover {
+  background-color: #101114 !important;
+}
+
+html[data-theme='dark'] .btn-neutral:visited {
+  color: #c1c1c1 !important;
+}
+
+html[data-theme='dark'] .btn {
+  box-shadow: none;
+}
+
+html[data-theme='dark'] footer {
+  color: #bdbdbd;
+}
+
+html[data-theme='dark'] .wy-nav-side {
+  background-color: #0d0d0d;
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.current {
+  background-color: #141414;
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.current > a,
+html[data-theme='dark'] .wy-menu-vertical li.on a {
+  background-color: #141415;
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.toctree-l1.current > a,
+html[data-theme='dark'] .wy-menu-vertical li.current a {
+  border-color: #0b0c0d;
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.current a {
+  color: #bbb;
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.current a:hover {
+  background-color: #222;
+}
+
+html[data-theme='dark'] .wy-menu-vertical a:hover,
+html[data-theme='dark'] .wy-menu-vertical li.current > a:hover,
+html[data-theme='dark'] .wy-menu-vertical li.on a:hover {
+  background-color: #1e1e1e;
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.toctree-l2.current > a,
+html[data-theme='dark']
+  .wy-menu-vertical
+  li.toctree-l2.current
+  li.toctree-l3
+  > a {
+  background-color: #18181a;
+}
+
+html[data-theme='dark'] .wy-side-nav-search {
+  background-color: #0b152d;
+}
+
+html[data-theme='dark'] .wy-side-nav-search .wy-dropdown > a,
+html[data-theme='dark'] .wy-side-nav-search > a {
+  color: #ddd;
+}
+
+html[data-theme='dark'] .wy-side-nav-search input[type='text'] {
+  border-color: #111;
+  background-color: #141414;
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'] .theme-switcher {
+  background-color: #0b0c0d;
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'].writer-html4 .rst-content dl:not(.docutils) > dt,
+html[data-theme='dark'].writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  > dt {
+  background-color: #0b0b0b;
+  color: #007dce;
+  border-color: #282828;
+}
+
+html[data-theme='dark'] .rst-content code,
+html[data-theme='dark'] .rst-content tt {
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'].writer-html4
+  .rst-content
+  dl:not(.docutils)
+  dl:not(.field-list)
+  > dt,
+html[data-theme='dark'].writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  dl:not(.field-list)
+  > dt {
+  background-color: #0f0f0f;
+  color: #959595;
+  border-color: #2b2b2b;
+}
+
+html[data-theme='dark'] .rst-content code,
+html[data-theme='dark'] .rst-content tt,
+html[data-theme='dark'] code {
+  background-color: #2d2d2d;
+  border-color: #1c1c1c;
+}
+
+html[data-theme='dark'] .rst-content code.xref,
+html[data-theme='dark'] .rst-content tt.xref,
+html[data-theme='dark'] a .rst-content code,
+html[data-theme='dark'] a .rst-content tt {
+  color: #cecece;
+}
+
+html[data-theme='dark'] .rst-content .hint,
+html[data-theme='dark'] .rst-content .important,
+html[data-theme='dark'] .rst-content .tip,
+html[data-theme='dark'] .rst-content .wy-alert-success.admonition,
+html[data-theme='dark'] .rst-content .wy-alert-success.admonition-todo,
+html[data-theme='dark'] .rst-content .wy-alert-success.attention,
+html[data-theme='dark'] .rst-content .wy-alert-success.caution,
+html[data-theme='dark'] .rst-content .wy-alert-success.danger,
+html[data-theme='dark'] .rst-content .wy-alert-success.error,
+html[data-theme='dark'] .rst-content .wy-alert-success.note,
+html[data-theme='dark'] .rst-content .wy-alert-success.seealso,
+html[data-theme='dark'] .rst-content .wy-alert-success.warning,
+html[data-theme='dark'] .wy-alert.wy-alert-success {
+  background-color: #00392e;
+}
+
+html[data-theme='dark'] .rst-content .hint .admonition-title,
+html[data-theme='dark'] .rst-content .hint .wy-alert-title,
+html[data-theme='dark'] .rst-content .important .admonition-title,
+html[data-theme='dark'] .rst-content .important .wy-alert-title,
+html[data-theme='dark'] .rst-content .tip .admonition-title,
+html[data-theme='dark'] .rst-content .tip .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.admonition-todo
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.admonition-todo
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.admonition
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.admonition
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.attention
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.attention
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.caution
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.caution .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.danger .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.danger .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.error .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.error .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.note .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.note .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.seealso
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.seealso .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-success.warning
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-success.warning .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert.wy-alert-success
+  .admonition-title,
+html[data-theme='dark']
+  .wy-alert.wy-alert-success
+  .rst-content
+  .admonition-title,
+html[data-theme='dark'] .wy-alert.wy-alert-success .wy-alert-title {
+  background-color: #006a56;
+}
+
+html[data-theme='dark'] .rst-content .note,
+html[data-theme='dark'] .rst-content .seealso,
+html[data-theme='dark'] .rst-content .wy-alert-info.admonition,
+html[data-theme='dark'] .rst-content .wy-alert-info.admonition-todo,
+html[data-theme='dark'] .rst-content .wy-alert-info.attention,
+html[data-theme='dark'] .rst-content .wy-alert-info.caution,
+html[data-theme='dark'] .rst-content .wy-alert-info.danger,
+html[data-theme='dark'] .rst-content .wy-alert-info.error,
+html[data-theme='dark'] .rst-content .wy-alert-info.hint,
+html[data-theme='dark'] .rst-content .wy-alert-info.important,
+html[data-theme='dark'] .rst-content .wy-alert-info.tip,
+html[data-theme='dark'] .rst-content .wy-alert-info.warning,
+html[data-theme='dark'] .wy-alert.wy-alert-info {
+  background-color: #002c4d;
+}
+
+html[data-theme='dark'] .rst-content .note .admonition-title,
+html[data-theme='dark'] .rst-content .note .wy-alert-title,
+html[data-theme='dark'] .rst-content .seealso .admonition-title,
+html[data-theme='dark'] .rst-content .seealso .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-info.admonition-todo
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-info.admonition-todo
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-info.admonition
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.admonition .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.attention .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.attention .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.caution .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.caution .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.danger .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.danger .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.error .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.error .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.hint .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.hint .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.important .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.important .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.tip .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.tip .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.warning .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-info.warning .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert.wy-alert-info .admonition-title,
+html[data-theme='dark'] .wy-alert.wy-alert-info .rst-content .admonition-title,
+html[data-theme='dark'] .wy-alert.wy-alert-info .wy-alert-title {
+  background-color: #004a7b;
+}
+
+html[data-theme='dark'] .rst-content .admonition-todo,
+html[data-theme='dark'] .rst-content .attention,
+html[data-theme='dark'] .rst-content .caution,
+html[data-theme='dark'] .rst-content .warning,
+html[data-theme='dark'] .rst-content .wy-alert-warning.admonition,
+html[data-theme='dark'] .rst-content .wy-alert-warning.danger,
+html[data-theme='dark'] .rst-content .wy-alert-warning.error,
+html[data-theme='dark'] .rst-content .wy-alert-warning.hint,
+html[data-theme='dark'] .rst-content .wy-alert-warning.important,
+html[data-theme='dark'] .rst-content .wy-alert-warning.note,
+html[data-theme='dark'] .rst-content .wy-alert-warning.seealso,
+html[data-theme='dark'] .rst-content .wy-alert-warning.tip,
+html[data-theme='dark'] .wy-alert.wy-alert-warning {
+  background-color: #533500;
+}
+
+html[data-theme='dark'] .rst-content .admonition-todo .admonition-title,
+html[data-theme='dark'] .rst-content .admonition-todo .wy-alert-title,
+html[data-theme='dark'] .rst-content .attention .admonition-title,
+html[data-theme='dark'] .rst-content .attention .wy-alert-title,
+html[data-theme='dark'] .rst-content .caution .admonition-title,
+html[data-theme='dark'] .rst-content .caution .wy-alert-title,
+html[data-theme='dark'] .rst-content .warning .admonition-title,
+html[data-theme='dark'] .rst-content .warning .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-warning.admonition
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-warning.admonition
+  .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.danger .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.danger .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.error .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.error .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.hint .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.hint .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-warning.important
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-warning.important
+  .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.note .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.note .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-warning.seealso
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.seealso .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.tip .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-warning.tip .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert.wy-alert-warning
+  .admonition-title,
+html[data-theme='dark']
+  .wy-alert.wy-alert-warning
+  .rst-content
+  .admonition-title,
+html[data-theme='dark'] .wy-alert.wy-alert-warning .wy-alert-title {
+  background-color: #803b00;
+}
+
+html[data-theme='dark'] .rst-content .danger,
+html[data-theme='dark'] .rst-content .error,
+html[data-theme='dark'] .rst-content .wy-alert-danger.admonition,
+html[data-theme='dark'] .rst-content .wy-alert-danger.admonition-todo,
+html[data-theme='dark'] .rst-content .wy-alert-danger.attention,
+html[data-theme='dark'] .rst-content .wy-alert-danger.caution,
+html[data-theme='dark'] .rst-content .wy-alert-danger.hint,
+html[data-theme='dark'] .rst-content .wy-alert-danger.important,
+html[data-theme='dark'] .rst-content .wy-alert-danger.note,
+html[data-theme='dark'] .rst-content .wy-alert-danger.seealso,
+html[data-theme='dark'] .rst-content .wy-alert-danger.tip,
+html[data-theme='dark'] .rst-content .wy-alert-danger.warning,
+html[data-theme='dark'] .wy-alert.wy-alert-danger {
+  background-color: #82231a;
+}
+
+html[data-theme='dark'] .rst-content .danger .admonition-title,
+html[data-theme='dark'] .rst-content .danger .wy-alert-title,
+html[data-theme='dark'] .rst-content .error .admonition-title,
+html[data-theme='dark'] .rst-content .error .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.admonition-todo
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.admonition-todo
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.admonition
+  .admonition-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.admonition
+  .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.attention
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.attention .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.caution .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.caution .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.hint .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.hint .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert-danger.important
+  .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.important .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.note .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.note .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.seealso .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.seealso .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.tip .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.tip .wy-alert-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.warning .admonition-title,
+html[data-theme='dark'] .rst-content .wy-alert-danger.warning .wy-alert-title,
+html[data-theme='dark']
+  .rst-content
+  .wy-alert.wy-alert-danger
+  .admonition-title,
+html[data-theme='dark']
+  .wy-alert.wy-alert-danger
+  .rst-content
+  .admonition-title,
+html[data-theme='dark'] .wy-alert.wy-alert-danger .wy-alert-title {
+  background-color: #b9372b;
+}
+
+html[data-theme='dark'] .wy-nav-top {
+  background-color: #0b152d;
+}
+
+html[data-theme='dark'] .rst-content table.docutils thead,
+html[data-theme='dark'] .rst-content table.field-list thead,
+html[data-theme='dark'] .wy-table thead {
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark']
+  .rst-content
+  table.docutils:not(.field-list)
+  tr:nth-child(2n-1)
+  td,
+html[data-theme='dark'] .wy-table-backed,
+html[data-theme='dark'] html[data-theme='dark'] .wy-table-odd td,
+html[data-theme='dark'] .wy-table-striped tr:nth-child(2n-1) td {
+  background-color: #181818;
+}
+
+html[data-theme='dark'] .rst-content table.docutils td,
+html[data-theme='dark'] .wy-table-bordered-all td,
+html[data-theme='dark'].writer-html5 .rst-content table.docutils th,
+html[data-theme='dark'] .rst-content table.docutils,
+html[data-theme='dark'] .wy-table-bordered-all {
+  border-color: #262626;
+}
+
+html[data-theme='dark'] .rst-content table.docutils caption,
+html[data-theme='dark'] .rst-content table.field-list caption,
+html[data-theme='dark'] .wy-table caption {
+  color: var(--dark-text-color);
+}
+
+html[data-theme='dark'] .wy-menu-vertical li.toctree-l3.current > a,
+html[data-theme='dark']
+  .wy-menu-vertical
+  li.toctree-l3.current
+  li.toctree-l4
+  > a {
+  background-color: #18181a;
+}
diff --git a/docs/_static/dark_mode_css/general.css b/docs/_static/dark_mode_css/general.css
new file mode 100644
index 00000000..aa614f81
--- /dev/null
+++ b/docs/_static/dark_mode_css/general.css
@@ -0,0 +1,68 @@
+input[type='color'],
+input[type='date'],
+input[type='datetime-local'],
+input[type='datetime'],
+input[type='email'],
+input[type='month'],
+input[type='number'],
+input[type='password'],
+input[type='search'],
+input[type='tel'],
+input[type='text'],
+input[type='time'],
+input[type='url'],
+input[type='week'] {
+  box-shadow: none;
+}
+
+.theme-switcher {
+  border-radius: 50%;
+  position: fixed;
+  right: 1.6em;
+  bottom: 1.4em;
+  z-index: 3;
+  border: none;
+  height: 2.2em;
+  width: 2.2em;
+  background-color: #fcfcfc;
+  font-size: 20px;
+  -webkit-box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.62);
+  box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.62);
+  color: #404040;
+  transition: all 0.3s ease-in-out;
+}
+
+body,
+.wy-nav-content-wrap,
+.wy-nav-content,
+.section,
+.highlight,
+.rst-content div[class^='highlight'],
+.wy-nav-content a,
+.btn-neutral,
+.btn,
+footer,
+.wy-nav-side,
+.wy-menu-vertical li,
+.wy-menu-vertical a,
+.wy-side-nav-search .wy-dropdown,
+.wy-side-nav-search a,
+.wy-side-nav-search input,
+html.writer-html4 .rst-content dl:not(.docutils) > dt,
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  > dt,
+.rst-content code,
+.rst-content tt,
+html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt,
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
+  dl:not(.field-list)
+  > dt,
+code,
+.rst-content code.xref,
+.rst-content tt.xref {
+  transition: all 0.2s ease-in-out;
+}
diff --git a/docs/_static/dark_mode_js/default_dark.js b/docs/_static/dark_mode_js/default_dark.js
new file mode 100644
index 00000000..ea63e072
--- /dev/null
+++ b/docs/_static/dark_mode_js/default_dark.js
@@ -0,0 +1,13 @@
+const loadTheme = () => {
+  let theme = localStorage.getItem('theme');
+
+  if (theme !== null) {
+    if (theme === 'dark')
+      document.documentElement.setAttribute('data-theme', 'dark');
+  } else {
+    localStorage.setItem('theme', 'dark');
+    document.documentElement.setAttribute('data-theme', 'dark');
+  }
+};
+
+loadTheme();
diff --git a/docs/_static/dark_mode_js/default_light.js b/docs/_static/dark_mode_js/default_light.js
new file mode 100644
index 00000000..2b19f92e
--- /dev/null
+++ b/docs/_static/dark_mode_js/default_light.js
@@ -0,0 +1,13 @@
+const loadTheme = () => {
+  let theme = localStorage.getItem('theme');
+
+  if (theme !== null) {
+    if (theme === 'dark')
+      document.documentElement.setAttribute('data-theme', 'dark');
+  } else {
+    localStorage.setItem('theme', 'light');
+    document.documentElement.setAttribute('data-theme', 'light');
+  }
+};
+
+loadTheme();
diff --git a/docs/_static/dark_mode_js/theme_switcher.js b/docs/_static/dark_mode_js/theme_switcher.js
new file mode 100644
index 00000000..860bd5d7
--- /dev/null
+++ b/docs/_static/dark_mode_js/theme_switcher.js
@@ -0,0 +1,39 @@
+const createThemeSwitcher = () => {
+  let btn = document.createElement('BUTTON');
+  btn.className = 'theme-switcher';
+  btn.id = 'themeSwitcher';
+  btn.innerHTML =
+    '';
+  document.body.appendChild(btn);
+
+  if (localStorage.getItem('theme') === 'dark') $('#themeMoon').hide(0);
+  else $('#themeSun').hide(0);
+};
+
+$(document).ready(() => {
+  createThemeSwitcher();
+  $('#themeSwitcher').click(switchTheme);
+
+  $('footer').html(
+    $('footer').html() +
+      'Dark theme provided by MrDogeBro.'
+  );
+});
+
+const switchTheme = () => {
+  if (localStorage.getItem('theme') === 'dark') {
+    localStorage.setItem('theme', 'light');
+    document.documentElement.setAttribute('data-theme', 'light');
+
+    $('#themeSun').fadeOut(200, () => {
+      $('#themeMoon').fadeIn(200);
+    });
+  } else {
+    localStorage.setItem('theme', 'dark');
+    document.documentElement.setAttribute('data-theme', 'dark');
+
+    $('#themeMoon').fadeOut(200, () => {
+      $('#themeSun').fadeIn(200);
+    });
+  }
+};
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 87107c65..7ed2e324 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v7.0.0',
+    VERSION: 'v7.0.2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/docs/_static/yfpy-logo.png b/docs/_static/yfpy-logo.png
new file mode 100644
index 00000000..efcc54e9
Binary files /dev/null and b/docs/_static/yfpy-logo.png differ
diff --git a/docs/genindex.html b/docs/genindex.html
index 402b9499..7e6f6de8 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -3,9 +3,12 @@
 
   
   
-  Index — YFPY v7.0.0 documentation
+  Index — YFPY v7.0.2 documentation
       
       
+      
+      
+      
   
@@ -14,6 +17,8 @@
         
         
         
+        
+        
     
     
      
@@ -24,8 +29,12 @@
     
 
       
      
-        
      
+        
      
           
      
   
-  
+  
-  
+  
      
           
      
@@ -85,31 +174,34 @@ 
      By Wren J. R. (uberfastman)PyPI
 PyPI
 PyPI
      
-
 
      
-
      
-
      Do you like the YFPY API wrapper? Star the repository here on GitHub and please consider helping support its ongoing development:
      
-
        
      
+
      Do you like the YFPY API wrapper? Star the repository on GitHub and please consider helping support its ongoing development:
      
+
        
      
 
-
-
+
+
-
-
+
+
-
-
+
+
      
 
      Cryptocurrency
      Address
      Cryptocurrency
      Address
      		
 
      
       
 
      Bitcoin (BTC)
      bc1qataspvklhewtswm357m0677q4raag5new2xt3e
      Bitcoin (BTC)
      bc1qataspvklhewtswm357m0677q4raag5new2xt3e
      		
 
      Ethereum (ETH)
      0x5eAa522e66a90577D49e9E72f253EC952CDB4059
      Ethereum (ETH)
      0x5eAa522e66a90577D49e9E72f253EC952CDB4059
      		
 
      
       
 
      
+
      
 
      
 
 
      
 
      
 
      Yahoo Fantasy Sports API Wrapper (YFPY)
      
+
      
+
      READ THE DOCS HERE!
      
+
      Detailed documentation on YFPY can be found at https://yfpy.uberfastman.com.
      
+
      
 
      
 
      Table of Contents
      
 
 
@@ -184,8 +276,8 @@ 
      Usage
 
      Testing
      
 
      YFPY has a collection of fully functional code snippets that can be run using pytest. These snippets demonstrate how to use YFPY to retrieve your Yahoo Fantasy Sports data.
      
 
        
-
      • See the test/integration directory for the example code snippets.
        • 
-
      • Before running any tests, make a copy of test/integration/EXAMPLE.env in the test/integration directory and rename it to .env.
        • 
+
      • See the test/integration directory for the example code snippets.
        • 
+
      • Before running any tests, make a copy of test/integration/EXAMPLE.env in the 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.
        • 
 
      • 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:
        
@@ -193,14 +285,14 @@ 
        Testingpytest -v -s
        • 
 
      
 
-
    • If you want to run only the integration tests, you can run:
      
+
    • If you want to run only the unit tests, you can run:
      
 
        
-
      • pytest -v -s -m integration
        • 
+
      • pytest -v -s -m unit
        • 
 
      
 
      • 
-
    • If you want to run only the unit tests, you can run:
      
+
    • If you want to run only the integration tests, you can run:
      
 
        
-
      • pytest -v -s -m unit
        • 
+
      • pytest -v -s -m integration
        • 
 
      
 
      •
    diff --git a/docs/objects.inv b/docs/objects.inv index 06bde285..93d21fe6 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 825838d0..d4407f3d 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -3,9 +3,12 @@ - Python Module Index — YFPY v7.0.0 documentation + Python Module Index — YFPY v7.0.2 documentation + + + @@ -14,6 +17,8 @@ + + @@ -27,8 +32,12 @@
    -
    +