API reference

Auto-generated from docstrings via mkdocstrings. For higher-level context — what each subpackage does and how data flows — see the architecture page.

Public top-level exports

The most-used entry points are re-exported from the package root:

from fantasyfb import (
    League,                            # main entry point
    FantasyScorer,                     # scoring rules -> points
    MatchupModel, ProjectionEngineV2,  # projection internals
    LineupOptimizer,
    SeasonSimulator, ScheduleManager,
    NflreadpyProvider,                 # default data backend
)

Pages

• League — top-level League class.
• Projections — ProjectionEngineV2, MatchupModel, model_fitter.
• Simulation — SeasonSimulator, ScheduleManager, backtest.
• Drafts — compute_vorp, assign_tiers, MockDraft, snake cockpit views.
• Scoring — FantasyScorer, LineupOptimizer, MatchupModel.
• Data providers — Yahoo client, NflreadpyProvider.
• I/O — FantasyExcelExporter, FantasyHtmlExporter.

Configs helper

from fantasyfb import get_league_config, apply_default_scoring_categories

fantasyfb.configs.get_league_config

get_league_config(platform: str)

Get predefined configuration for a specific platform.

Parameters:

Name	Type	Description	Default
platform	str	Platform name ('draftkings'/'dk', 'underdog', 'standard', 'half_ppr'/'half-ppr', 'ppr')	required

Returns:

Type	Description
	Dict containing scoring and roster configuration, or None if not found

fantasyfb.configs.apply_default_scoring_categories

apply_default_scoring_categories(scoring: dict)

Add missing scoring categories with default values of 0.0.

Parameters:

Name	Type	Description	Default
scoring	dict	Dictionary of scoring settings	required

Returns:

Type	Description
	Dictionary with all expected scoring categories