📆 Calendar App

bigtree.workflows.app_calendar

Calendar

Calendar(name)

Calendar Implementation with Big Tree. - Calendar has four levels - year, month, day, and event name (with event attributes)

Examples:

Initializing and Adding Events

>>> from bigtree import Calendar
>>> calendar = Calendar("My Calendar")
>>> calendar.add_event("Gym", "2023-01-01 18:00")
>>> calendar.add_event("Dinner", "2023-01-01", date_format="%Y-%m-%d", budget=20)
>>> calendar.add_event("Gym", "2023-01-02 18:00")
>>> calendar.show()
My Calendar
2023-01-01 00:00:00 - Dinner (budget: 20)
2023-01-01 18:00:00 - Gym
2023-01-02 18:00:00 - Gym

Search for Events

>>> calendar.find_event("Gym")
2023-01-01 18:00:00 - Gym
2023-01-02 18:00:00 - Gym

Removing Events

>>> import datetime as dt
>>> calendar.delete_event("Gym", dt.date(2023, 1, 1))
>>> calendar.show()
My Calendar
2023-01-01 00:00:00 - Dinner (budget: 20)
2023-01-02 18:00:00 - Gym

Export Calendar

>>> calendar.to_dataframe()
                             path    name        date      time  budget
0  /My Calendar/2023/01/01/Dinner  Dinner  2023-01-01  00:00:00    20.0
1     /My Calendar/2023/01/02/Gym     Gym  2023-01-02  18:00:00     NaN

add_event

add_event(
    event_name,
    event_datetime,
    date_format="%Y-%m-%d %H:%M",
    **kwargs
)

Add event to calendar

Parameters:

Name	Type	Description	Default
`event_name`	`str`	event name to be added	required
`event_datetime`	`Union[str, datetime]`	event date and time	required
`date_format`	`str`	specify datetime format if event_datetime is str	`'%Y-%m-%d %H:%M'`

delete_event

delete_event(event_name, event_date=None)

Delete event from calendar

Parameters:

Name	Type	Description	Default
`event_name`	`str`	event name to be deleted	required
`event_date`	`date`	event date to be deleted	`None`

find_event

find_event(event_name)

Find event by name, prints result to console

Parameters:

Name	Type	Description	Default
`event_name`	`str`	event name	required

show

show()

Show calendar, prints result to console

to_dataframe

to_dataframe()

Export calendar to DataFrame

Returns:

Type	Description
`DataFrame`	(pd.DataFrame)