sync_ics2gcal package

Submodules

sync_ics2gcal.gcal module

class sync_ics2gcal.gcal.ACLRule

Bases: TypedDict

role: str

scope: ACLScope

class sync_ics2gcal.gcal.ACLScope

Bases: TypedDict

type: str

value: str

class sync_ics2gcal.gcal.CalendarData

Bases: TypedDict

description: str

id: str

summary: str

timeZone: str

class sync_ics2gcal.gcal.EventData

Bases: TypedDict

created: str

description: str

end: EventDate | EventDateTime

iCalUID: str

id: str

location: str

sequence: int

start: EventDate | EventDateTime

status: str

summary: str

transparency: str

updated: str

visibility: str

class sync_ics2gcal.gcal.EventDate

Bases: TypedDict

date: str

timeZone: str

class sync_ics2gcal.gcal.EventDateTime

Bases: TypedDict

dateTime: str

timeZone: str

class sync_ics2gcal.gcal.EventsSearchResults(exists, new)

Bases: NamedTuple

exists: List[Tuple[EventData, EventData]]

Alias for field number 0

new: List[EventData]

Alias for field number 1

class sync_ics2gcal.gcal.GoogleCalendar(service: Resource, calendar_id: str | None)

Bases: object

class to interact with calendar on Google

add_owner(email: str) → None

add calendar owner by email

Arguments:

email – email to add

calendar_id: str

create(summary: str, time_zone: str | None = None) → Any

create calendar

Arguments:

summary – new calendar summary

Keyword Arguments:

timeZone – new calendar timezone as string (optional)

Returns:

calendar Resource

delete() → None

delete calendar

delete_events(events: List[EventData]) → None

delete events

Arguments:

events – list of events

find_exists(events: List[EventData]) → EventsSearchResults

find existing events from list, by ‘iCalUID’ field

Arguments:

events {list} – list of events

Returns:

EventsSearchResults – (events_exist, events_not_found)

events_exist - list of tuples: (new_event, exists_event)

insert_events(events: List[EventData]) → None

insert list of events

Arguments:

events - events list

list_events_from(start: datetime) → List[EventData]

list events from calendar, where start date >= start

logger = <Logger GoogleCalendar (WARNING)>

make_public() → None

make calendar public

patch_events(event_tuples: List[Tuple[EventData, EventData]]) → None

patch (update) events

Arguments:

event_tuples – list of tuples: (new_event, exists_event)

service: Resource

update_events(event_tuples: List[Tuple[EventData, EventData]]) → None

update events

Arguments:

event_tuples – list of tuples: (new_event, exists_event)

class sync_ics2gcal.gcal.GoogleCalendarService

Bases: object

class for make google calendar service Resource

Returns:

service Resource

static default() → Resource

make service Resource from default credentials (authorize) ( https://developers.google.com/identity/protocols/application-default-credentials ) ( https://googleapis.dev/python/google-auth/latest/reference/google.auth.html#google.auth.default )

static from_config(config: Dict[str, str] | None = None) → Resource

make service Resource from config dict

Arguments:

config – config with keys:

(optional) service_account: - service account filename if key not in dict then default credentials will be used ( https://developers.google.com/identity/protocols/application-default-credentials )

– None: default credentials will be used

static from_srv_acc_file(service_account_file: str) → Resource

make service Resource from service account filename (authorize)

sync_ics2gcal.gcal.select_event_key(event: EventData) → str | None

select event key for logging

Arguments:

event – event resource

Returns:

key name or None if no key found

sync_ics2gcal.ical module

class sync_ics2gcal.ical.CalendarConverter(calendar: Calendar | None = None)

Bases: object

Convert icalendar events to google calendar resources

events_to_gcal() → List[EventData]

Convert events to google calendar resources

load(filename: str) → None

load calendar from ics file

loads(string: str) → None

load calendar from ics string

logger = <Logger CalendarConverter (WARNING)>

class sync_ics2gcal.ical.EventConverter(*args, **kwargs)

Bases: Event

Convert icalendar event to google calendar resource ( https://developers.google.com/calendar/v3/reference/events#resource-representations )

convert() → EventData

Convert

Returns:

dict - google calendar#event resource

sync_ics2gcal.ical.format_datetime_utc(value: date | datetime) → str

utc datetime as string from date or datetime value

Arguments:

value – date or datetime value

Returns:

utc datetime value as string in iso format

sync_ics2gcal.ical.gcal_date_or_datetime(value: date | datetime, check_value: date | datetime | None = None) → EventDate | EventDateTime

date or datetime to gcal (start or end dict)

Arguments:

value: date or datetime check_value: optional for choose result type

Returns:

{ ‘date’: … } or { ‘dateTime’: … }

sync_ics2gcal.manage_calendars module

class sync_ics2gcal.manage_calendars.Commands(config: str = 'config.yml')

Bases: object

manage google calendars in service account

add_owner(calendar_id: str, email: str) → None

add owner to calendar

Args:

calendar_id: calendar id email: new owner email

create(summary: str, timezone: str | None = None, public: bool = False) → None

create calendar

Args:

summary: new calendar summary timezone: new calendar timezone public: make calendar public

list(show_hidden: bool = False, show_deleted: bool = False) → None

list calendars

Args:

show_hidden: show hidden calendars show_deleted: show deleted calendars

remove(calendar_id: str) → None

remove calendar

Args:

calendar_id: calendar id

rename(calendar_id: str, summary: str) → None

rename calendar

Args:

calendar_id: calendar id summary:

class sync_ics2gcal.manage_calendars.PropertyCommands(_service: Any)

Bases: object

get/set google calendar properties

get(calendar_id: str, property_name: str) → None

get calendar property

Args:

calendar_id: calendar id property_name: property key

set(calendar_id: str, property_name: str, property_value: str) → None

set calendar property

Args:

calendar_id: calendar id property_name: property key property_value: property value

sync_ics2gcal.manage_calendars.load_config(filename: str) → Dict[str, Any] | None

sync_ics2gcal.manage_calendars.main() → None

sync_ics2gcal.sync module

class sync_ics2gcal.sync.CalendarSync(gcalendar: GoogleCalendar, converter: CalendarConverter)

Bases: object

class for synchronize calendar with Google

apply() → None

apply sync (insert, update, delete), using prepared lists of events

clear() → None

clear prepared sync lists (insert, update, delete)

logger = <Logger CalendarSync (WARNING)>

prepare_sync(start_date: date | datetime) → None

prepare sync lists by comparison of events

Arguments:

start_date – date/datetime to start sync

class sync_ics2gcal.sync.ComparedEvents(added: List[EventData], changed: List[Tuple[EventData, EventData]], deleted: List[EventData])

Bases: NamedTuple

Compared events

added: List[EventData]

Alias for field number 0

changed: List[Tuple[EventData, EventData]]

Alias for field number 1

deleted: List[EventData]

Alias for field number 2

sync_ics2gcal.sync_calendar module

sync_ics2gcal.sync_calendar.get_start_date(date: str | datetime) → datetime

sync_ics2gcal.sync_calendar.load_config() → Dict[str, Any]

sync_ics2gcal.sync_calendar.main() → None

Module contents

class sync_ics2gcal.ACLRule

Bases: TypedDict

role: str

scope: ACLScope

class sync_ics2gcal.ACLScope

Bases: TypedDict

type: str

value: str

class sync_ics2gcal.CalendarConverter(calendar: Calendar | None = None)

Bases: object

Convert icalendar events to google calendar resources

calendar: Calendar | None

events_to_gcal() → List[EventData]

Convert events to google calendar resources

load(filename: str) → None

load calendar from ics file

loads(string: str) → None

load calendar from ics string

logger = <Logger CalendarConverter (WARNING)>

class sync_ics2gcal.CalendarData

Bases: TypedDict

description: str

id: str

summary: str

timeZone: str

class sync_ics2gcal.CalendarSync(gcalendar: GoogleCalendar, converter: CalendarConverter)

Bases: object

class for synchronize calendar with Google

apply() → None

apply sync (insert, update, delete), using prepared lists of events

clear() → None

clear prepared sync lists (insert, update, delete)

converter: CalendarConverter

gcalendar: GoogleCalendar

logger = <Logger CalendarSync (WARNING)>

prepare_sync(start_date: date | datetime) → None

prepare sync lists by comparison of events

Arguments:

start_date – date/datetime to start sync

to_delete: List[EventData]

to_insert: List[EventData]

to_update: List[Tuple[EventData, EventData]]

class sync_ics2gcal.ComparedEvents(added: List[EventData], changed: List[Tuple[EventData, EventData]], deleted: List[EventData])

Bases: NamedTuple

Compared events

added: List[EventData]

Alias for field number 0

changed: List[Tuple[EventData, EventData]]

Alias for field number 1

deleted: List[EventData]

Alias for field number 2

class sync_ics2gcal.EventConverter(*args, **kwargs)

Bases: Event

Convert icalendar event to google calendar resource ( https://developers.google.com/calendar/v3/reference/events#resource-representations )

convert() → EventData

Convert

Returns:

dict - google calendar#event resource

class sync_ics2gcal.EventData

Bases: TypedDict

created: str

description: str

end: EventDate | EventDateTime

iCalUID: str

id: str

location: str

sequence: int

start: EventDate | EventDateTime

status: str

summary: str

transparency: str

updated: str

visibility: str

class sync_ics2gcal.EventDate

Bases: TypedDict

date: str

timeZone: str

class sync_ics2gcal.EventDateTime

Bases: TypedDict

dateTime: str

timeZone: str

class sync_ics2gcal.EventsSearchResults(exists, new)

Bases: NamedTuple

exists: List[Tuple[EventData, EventData]]

Alias for field number 0

new: List[EventData]

Alias for field number 1

class sync_ics2gcal.GoogleCalendar(service: Resource, calendar_id: str | None)

Bases: object

class to interact with calendar on Google

add_owner(email: str) → None

add calendar owner by email

Arguments:

email – email to add

calendar_id: str

create(summary: str, time_zone: str | None = None) → Any

create calendar

Arguments:

summary – new calendar summary

Keyword Arguments:

timeZone – new calendar timezone as string (optional)

Returns:

calendar Resource

delete() → None

delete calendar

delete_events(events: List[EventData]) → None

delete events

Arguments:

events – list of events

find_exists(events: List[EventData]) → EventsSearchResults

find existing events from list, by ‘iCalUID’ field

Arguments:

events {list} – list of events

Returns:

EventsSearchResults – (events_exist, events_not_found)

events_exist - list of tuples: (new_event, exists_event)

insert_events(events: List[EventData]) → None

insert list of events

Arguments:

events - events list

list_events_from(start: datetime) → List[EventData]

list events from calendar, where start date >= start

logger = <Logger GoogleCalendar (WARNING)>

make_public() → None

make calendar public

patch_events(event_tuples: List[Tuple[EventData, EventData]]) → None

patch (update) events

Arguments:

event_tuples – list of tuples: (new_event, exists_event)

service: Resource

update_events(event_tuples: List[Tuple[EventData, EventData]]) → None

update events

Arguments:

event_tuples – list of tuples: (new_event, exists_event)

class sync_ics2gcal.GoogleCalendarService

Bases: object

class for make google calendar service Resource

Returns:

service Resource

static default() → Resource

make service Resource from default credentials (authorize) ( https://developers.google.com/identity/protocols/application-default-credentials ) ( https://googleapis.dev/python/google-auth/latest/reference/google.auth.html#google.auth.default )

static from_config(config: Dict[str, str] | None = None) → Resource

make service Resource from config dict

Arguments:

config – config with keys:

(optional) service_account: - service account filename if key not in dict then default credentials will be used ( https://developers.google.com/identity/protocols/application-default-credentials )

– None: default credentials will be used

static from_srv_acc_file(service_account_file: str) → Resource

make service Resource from service account filename (authorize)