status.status

status.status(config, date_input=None)

Return program status for a given date.

Parameters

Name	Type	Description	Default
config	config.py	Contains program date information, block structure, and break periods.	required
date_input	str or Python datetime object	Date at which program status is based upon. If None, defaults to today’s date.	None

Returns

Name	Type	Description
result	dict	Dictionary will be returned descibing academic position based on date. Dictionary is printed out in the console for viewing. DATE: general information on the input date. BLOCK: calculates which block you are in and the week within the block. BREAK: determines if you’re in a block or on holidays; if you are in a block, will tell you the next upcoming break and how far away it is; disingtuishes between holidays and weekends between blocks.

Examples

>>> status(config)

Displays program status from today’s date.

result = { “date”: date, “day_of_week”: date, “block”: None, “week_in_block”: None, “during_break”: False, “break_name”: None, “days_until_next_break”: None, “next_break_name”: None, “between_blocks” = False }