Python iCalendar implementation (rfc 2445)

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for allen.porter from gravatar.com allen.porter

Unverified details

These details have not been verified by PyPI
Meta
Report project as malware

Project description

This is an iCalendar rfc 5545 implementation in python. The goal of this project is to offer a calendar library that fills gaps in other widely used calendar libraries such as:

  • Relevant and practical features needed for building a calendar application -- namely recurring events.
  • Simple APIs that are straight forward to use
  • High quality code base with high test coverage and regular releases.

ical's main focus is on simplicity. Internally, this library uses other existing data parsing libraries making it easy to support as much as possible of rfc5545. It is not a goal to support everything exhaustively (e.g. enterprise features), however, the simplicity of the implementation makes it easy to do so. The package has high coverage, and high test coverage, and is easy to extend with new rfc5545 properties.

This packages uses semantic versioning, and releases often, and works on recent python versions.

See documentation for full quickstart and API reference.

Quickstart

The example below creates a Calendar, then adds an all day event to the calendar, then iterates over all events on the calendar.

from datetime import date

from ical.calendar import Calendar
from ical.event import Event

calendar = Calendar()
calendar.events.append(
    Event(summary="Event summary", start=date(2022, 7, 3), end=date(2022, 7, 4)),
)
for event in calendar.timeline:
    print(event.summary)

Reading ics files

This example parses an .ics file from disk and creates a ical.calendar.Calendar object, then prints out the events in order:

from pathlib import Path
from ical.calendar_stream import IcsCalendarStream
from ical.exceptions import CalendarParseError

filename = Path("example/calendar.ics")
with filename.open() as ics_file:
    try:
        calendar = IcsCalendarStream.calendar_from_ics(ics_file.read())
    except CalendarParseError as err:
        print(f"Failed to parse ics file '{str(filename)}': {err}")
    else:
        print([event.summary for event in calendar.timeline])

Writing ics files

This example writes a calendar object to an ics output file:

from pathlib import Path
from ical.calendar_stream import IcsCalendarStream

filename = Path("example/output.ics")
with filename.open() as ics_file:
    ics_file.write(IcsCalendarStream.calendar_to_ics(calendar))

Application-level APIs

The above APIs are used for lower level interaction with calendar components, however applications require a higher level interface to manage some of the underlying complexity. The ical.store library is used to manage state at a higher level (e.g. ensuring timezones are created properly) or handling edits to recurring events.

Recurring events

A calendar event may be recurring (e.g. weekly, monthly, etc). Recurring events are represented in a ical.calendar.Calendar with a single ical.event.Event object, however when observed through a ical.timeline.Timeline will be expanded based on the recurrence rule. See the rrule, rdate, and exdate fields on the ical.event.Event for more details.

Related Work

There are other python rfc5545 implementations that are more mature, and having been around for many years, are still active, and served as reference implementations for this project:

You may prefer these projects if you want something that changes less often or if you require a non-modern version of python and if you don't mind patching recurring events on top yourself e.g. using python-recurring-ical-events.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for allen.porter from gravatar.com allen.porter

Unverified details

These details have not been verified by PyPI
Meta

Release history Release notifications | RSS feed

This version

12.1.3

12.1.2

12.1.1

12.1.0

12.0.0

11.1.0

11.0.0

10.0.4

10.0.3

10.0.2

10.0.1

10.0.0

9.2.5

9.2.4

9.2.3

9.2.2

9.2.1

9.2.0

9.1.0

9.0.3

9.0.2

9.0.1

8.3.1

8.3.0

8.2.0

8.1.1

8.1.0

8.0.2

8.0.1

8.0.0

7.0.3

7.0.2

7.0.1

7.0.0

6.1.1

6.1.0

6.0.0

5.1.1

5.1.0

5.0.1

5.0.0

4.5.4

4.5.2

4.5.1

4.5.0

4.4.0

4.3.0

4.2.9

4.2.8

4.2.7

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.2

4.1.1

4.1.0

4.0.1

4.0.0

3.0.1

3.0.0

2.1.0

2.0.0

1.2.0

1.1.0

1.0.0

0.2.0

0.1.0

0.0.4

0.0.3

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ical-12.1.3.tar.gz (126.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ical-12.1.3-py3-none-any.whl (123.8 kB view details)

Uploaded Python 3

File details

Details for the file ical-12.1.3.tar.gz.

File metadata

  • Download URL: ical-12.1.3.tar.gz
  • Upload date:
  • Size: 126.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ical-12.1.3.tar.gz
Algorithm Hash digest
SHA256 90cce24a93a2a894c43780e60084180d6c10a9f3f06964831a24d802d8eb6f58
MD5 6383c02180d7193bfb93dcad15c6d7f6
BLAKE2b-256 7a959796e76852cb9bb2e9cb4e649b6fa2eee168a2cca385b848d4f2c3e16b9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ical-12.1.3.tar.gz:

Publisher: publish.yaml on allenporter/ical

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ical-12.1.3-py3-none-any.whl.

File metadata

  • Download URL: ical-12.1.3-py3-none-any.whl
  • Upload date:
  • Size: 123.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ical-12.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9b077522e0007237be88a28beff5d1c8bed1447159053c8b9cbc8f995356f9d2
MD5 ce49b99225bce79876291cde8faecf7d
BLAKE2b-256 4bd2af52017b1f4ebee39575b57330ee6389ba72b6c4ca0a75c1b1d2dc8bdf38

See more details on using hashes here.

Provenance

The following attestation bundles were made for ical-12.1.3-py3-none-any.whl:

Publisher: publish.yaml on allenporter/ical

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page