Link Search Menu Expand Document

Building the Archive

The .build() method retrieves archive entry data for the archive and populates it as a dictionary to the BroadcastifyArchive.entries attribute.

build(start=None, end=None, days_back=None,
      chronological=False, rebuild=False)
ParameterData TypeRequirementDescription
startdateSee valid date parameter combinationsThe earliest date for which to populate the archive. Must be a valid date on the archive’s calendar
enddateSee valid date parameter combinationsThe latest date for which to populate the archive. Must be a valid date on the archive’s calendar
days_backintSee valid date parameter combinationsThe number of days before the current day to retrieve information for
chronologicalboolOptionalBy default, start with the latest date and work backward in time. If True, reverse that
rebuildboolOptional*Specifies that existing data in the entries attribute should be overwritten with data newly fetched from Broadcastify. If the entries attribute is not empty, this parameter must be set to True or an error will be raised
Valid Date Parameter Combinations
startenddays_backBehavior
SuppliedOmittedOmittedBuild entry list from start through the last date in the archive calendar, inclusive
OmittedSuppliedOmittedBuild entry list from first date in the archive calendar through end, inclusive
SuppliedSuppliedOmittedBuild entry list from start through end, inclusive
OmittedOmittedSuppliedBuild entry list from today’s date going days_back into the past. (Zero days back includes only the current day.)

All other combinations produce an error.