Install & Compatibility
Where this runs
tested against v0.9.9.20260518 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.075s · 21.9MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 1.7s · import 0.068s · 22MB
20MB installed
● package 20MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
vobject
✓ import vobject_stubs as vobject
✗ import vobject-stubs as vobject
This quickstart demonstrates how to use the `vobject` library with type hints. It shows creating a simple VCALENDAR with an event, adding properties, and serializing it. With `types-vobject` installed, a type checker will provide autocompletion and error checking for `vobject` objects and methods.
import vobject
from vobject.base import Component, VEvent
from typing import cast, List
# Install 'vobject' and 'types-vobject' first:
# pip install vobject types-vobject
def create_simple_calendar() -> Component:
"""Creates a VCALENDAR with a single VEVENT using type hints."""
# 'calendar' is inferred as vobject.base.Component
calendar = vobject.newFromBehavior('vcalendar')
# Add an event component
event: Component = calendar.add('vevent')
# Accessing the event via vevent_list is type-safe due to stubs
event_list: List[VEvent] = calendar.vevent_list
first_event = event_list[0] # first_event is inferred as VEvent
first_event.add('dtstart').value = '20231027T100000'
first_event.add('dtend').value = '20231027T110000'
first_event.add('summary').value = 'Meeting with client'
first_event.add('description').value = 'Discuss project roadmap and next steps.'
return calendar
if __name__ == '__main__':
my_calendar = create_simple_calendar()
print(my_calendar.serialize())
# Accessing properties with type safety
first_event: VEvent = my_calendar.vevent_list[0]
print(f"\nEvent Summary: {first_event.summary.value}")
print(f"Event Description: {first_event.description.value}")
print(f"Event Start: {first_event.dtstart.value}")
Upgrade
Version history
0.9.9.20260518latest on PyPI · released May 18, 2026
Audit
Dependencies
vobjectoptionalThe stubs are useless without the actual `vobject` library installed for runtime execution.