Skip to main content

Generate a iCalendar (.ics) file based on a OrgMode (.org) file.

Project description

org2ical

pypi python Downloads license

tests build codecov

Generate an iCalendar (.ics) file based on a OrgMode (.org) file.

This package is especially useful if your OrgMode file is too large to be exported with OrgMode iCalendar Export.

Installation:

pip install -U org2ical

Usage:

import org2ical
# Ref: https://orgmode.org/manual/Timestamps.html
org_str = """
* Meet Peter at the movies
  <2006-11-01 Wed 19:15>
* Discussion on climate change
  <2006-11-02 Thu 20:00-22:00>
"""
ical_str, warnings = org2ical.loads(org_str)
assert warnings == []
print(ical_str)

Results:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//j3soon//org2ical//EN
BEGIN:VEVENT
DTSTAMP:20221114T153849Z
UID:2f8059beaf05751acc703c2a12eee7e8
DTSTART:20061101T191500Z
DTEND:20061101T191500Z
SUMMARY:Meet Peter at the movies
DESCRIPTION:  <2006-11-01 Wed 19:15>\n\nOrg Path: Meet Peter at the movies
CATEGORIES:TIMESTAMP
END:VEVENT
BEGIN:VEVENT
DTSTAMP:20221114T153849Z
UID:72b76db7dacae0489b50bb9c9b3b3c34
DTSTART:20061102T200000Z
DTEND:20061102T220000Z
SUMMARY:Discussion on climate change
DESCRIPTION:  <2006-11-02 Thu 20:00-22:00>\n\nOrg Path: Discussion on climate change
CATEGORIES:TIMESTAMP
END:VEVENT
END:VCALENDAR

Please note that the DTSTAMP here depends on your current time.

Import to Thunderbird's Lightning Calendar

  1. Export a Org (.org) file to an iCal (.ics) file using org2ical.
  2. In Thunderbird, select Events and Tasks > Import... and follow the steps to import the iCal file.
  3. (Optional) Set category colors:
    DEADLINE : rgb(255, 128, 128)
    SCHEDULED: rgb(128, 192, 128)
    TIMESTAMP: rgb(128, 128, 255)
    CLOCK    : rgb(255, 192, 128)
    
  4. (Optional) Fill events with category color by following this Stack Overflow answer.

Project details


Download files

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

Source Distribution

org2ical-0.0.4.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

org2ical-0.0.4-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file org2ical-0.0.4.tar.gz.

File metadata

  • Download URL: org2ical-0.0.4.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for org2ical-0.0.4.tar.gz
Algorithm Hash digest
SHA256 e1313face4e48e0b8ecd18054a098010c3c1ebdd9feb2be50b141ebfa9ec0582
MD5 354aa795d71c61fdf2debd4360530795
BLAKE2b-256 b452ffbc6c93fcfe428c93865fb2df7ffd315656305631a9581615c6b144054d

See more details on using hashes here.

File details

Details for the file org2ical-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: org2ical-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for org2ical-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cdcba17b50edfded94c4af472929e91e3f5ec6d97106527919b189670f9b9b00
MD5 e16fcf1099005fd5cb32c32516962126
BLAKE2b-256 3a61f9c1c1af932e076bae522e35172279672cfd7912d4e2fcfc4ddc181a9fd3

See more details on using hashes here.

Supported by

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