Skip to main content

Repair Google Calendar - This Python module and program makes ICS/iCalendar files using X-WR-TIMEZONE compatible with the RFC 5545 standard.

Project description

CI build and test status Python Package Version on Pypi Downloads from Pypi Support on Open Collective

Some calendar creators such as Google Calendar introduce the non-standard X-WR-TIMEZONE parameter to ICS calendar files to change the timezone. Strict interpretations according to RFC 5545 ignore the X-WR-TIMEZONE parameter. This causes the times of the events to differ from those which make use of X-WR-TIMEZONE.

This module aims to bridge the gap by converting calendars using X-WR-TIMEZONE to a strict RFC 5545 calendars. So, let’s put our heads together and solve this problem for everyone!

Some features of the module are:

  • Easy install with Python’s pip.

  • Command line conversion of calendars.

  • Piping of calendar files with wget or curl.

Some of the requirements are:

  • Calendars without X-WR-TIMEZONE are kept unchanged.

  • Passing calendars twice to this module does not change them.

Install

Install using pip:

python3 -m pip install x-wr-timezone

Install with apt:

sudo apt-get install python-x-wr-timezone

Support

Command Line Usage

You can standardize the calendars using your command line interface. The examples assume that in.ics is a calendar which may use X-WR-TIMEZONE, whereas out.ics does not require X-WR-TIMEZONE for proper display.

cat in.is | x-wr-timezone > out.ics
x-wr-timezone in.ics out.ics
curl https://example.org/in.ics | x-wr-timezone > out.ics
wget -O- https://example.org/in.ics | x-wr-timezone > out.ics

You can get usage help on the command line:

x-wr-timezone --help

Python

After you have installed the library, you can import it.

import x_wr_timezone

The function to_standard() converts an icalendar.Calendar.

x_wr_timezone.to_standard(an_icalendar)

Here is a full example which does about as much as this module is supposed to do:

import icalendar # installed with x_wr_timezone
import x_wr_timezone

with open("in.ics", 'rb') as file:
    calendar = icalendar.from_ical(file.read())
new_calendar = x_wr_timezone.to_standard(calendar)
# you could use the new_calendar variable now
with open('out.ics', 'wb') as file:
    file.write(new_calendar.to_ical())

to_standard(calendar, timezone=None) has these parameters:

  • calendar is the icalendar.Calendar object.

  • timezone is an optional time zone. By default, the time zone in calendar['X-WR-TIMEZONE'] is used to check if the calendar needs changing. When timezone is not None however, calendar['X-WR-TIMEZONE'] will not be tested and it is assumed that the calendar should be changed as if calendar['X-WR-TIMEZONE'] had the value of timezone. This does not add or change the value of calendar['X-WR-TIMEZONE']. You would need to do that yourself. timezone can be a string like "UTC" or "Europe/Berlin" or a pytz.timezone or something that datetime accepts as a time zone..

  • Return value: The calendar argument is not modified at all. The calendar returned has the attributes and subcomponents of the calendar only changed and copied where needed to return the proper value. As such, the returned calendar might be identical to the one passed to the function as the calendar argument. Keep that in mind if you modify the return value.

Development

  1. Clone the repository or its fork and cd x-wr-timezone.

  2. Optional: Install virtualenv and Python3 and create a virtual environment:

    pip install virtualenv
    virtualenv -p python3 ENV
    source ENV/bin/activate # you need to do this for each shell
  3. Install the packages and this module so it can be edited:

    pip install -r test-requirements.txt -e .
  4. Run the tests:

    pytest

To test all functions:

pytest --x-wr-timezone all

Testing with tox

You can use tox to test the package in different Python versions.

tox

This tests all the different functionalities:

tox -- --x-wr-timezone all

New Releases

To release new versions,

  1. edit the Changelog Section

  2. edit setup.py, the __version__ variable

  3. create a commit and push it

  4. Wait for CI tests to finish the build.

  5. run

    python3 setup.py tag_and_deploy
  6. notify the issues about their release

Add/Remove a Python Version

If you need to add or remove a Python version, you need to modify these files:

  • … README.rst in the changelog section

  • … setup.py

  • … tox.ini

  • … tests.yml

Testing

This project’s development is driven by tests. Tests assure a consistent interface and less knowledge lost over time. If you like to change the code, tests help that nothing breaks in the future. They are required in that sense. Example code and ics files can be transferred into tests and speed up fixing bugs.

You can view the tests in the test folder. If you have a calendar ICS file for which this library does not generate the desired output, you can add it to the test/calendars folder and write tests for what you expect. If you like, open an issue first, e.g. to discuss the changes and how to go about it.

Changelog

  • v2.0.1

    • Reuse the generated timezone component because that takes a long time.

    • Fix bug where the timezone was not changed in the result if you add the component.

  • v2.0.0

    • Add VTIMEZONE component by default to x-wr-timezone command.

    • Add --no-timezone parameter to skip adding the VTIMEZONE component.

    • Add add_timezone_component=False parameter to to_standard() to optionally add a timezone component in the resulting icalendar.Calendar.

    • Add click dependency.

  • v1.0.2

    • Add support for Python 3.13

  • v1.0.1

    • Use zoneinfo instead of pytz

    • Test compatibility with pytz and zoneinfo as argument to to_standard

    • Remove pytz as a dependency

    • Add tzdata as a dependency

    • Add typing

    • Update Python versions

  • v0.0.7

    • Rename master branch to main

    • Use proper SPDX license ID

    • Test Python 3.12

  • v0.0.6

    • Obsolete Python 3.7

    • Support Python 3.11

    • Fix localization issue for pytz when datetime has no timezone

    • Run tests on GitHub Actions

    • Require icalendar 5.0.11 for tests

    • Fix pytz localization issue when dateime is not in UTC and has no time zone.

  • v0.0.5

    • Revisit README and CLI and fix spelling mistakes.

    • Modified behavior to treat events without time zone found in a calendar using the X-WR-TIMEZONE property, see Pull Request 7

  • v0.0.4

    • Test automatic deployment with Gitlab CI.

  • v0.0.3

    • Use tzname() function of datetime to test for UTC. This helps support zoneinfo time zones.

    • Split up visitor class and rename it to walker.

  • v0.0.2

    • Implement the timezone argument.

    • Do not modify the value of the calendar argument and only copy it where needed.

  • v0.0.1

    • Initial release supports DTSTART, DTEND, EXDATE, RDATE, RECURRENCE-ID attributes of events.

    • Command line interface as x-wr-timezone.

Security Policy

We have a Security Policy in place.

License

This software is licensed under LGPLv3, see the LICENSE file.

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

x_wr_timezone-2.0.1.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

x_wr_timezone-2.0.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file x_wr_timezone-2.0.1.tar.gz.

File metadata

  • Download URL: x_wr_timezone-2.0.1.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for x_wr_timezone-2.0.1.tar.gz
Algorithm Hash digest
SHA256 9166c40e6ffd4c0edebabc354e1a1e2cffc1bb473f88007694793757685cc8c3
MD5 d8f954fdfe27e0767849882ff1e33ed0
BLAKE2b-256 792b8ae5f59ab852c8fe32dd37c1aa058eb98aca118fec2d3af5c3cd56fffb7b

See more details on using hashes here.

File details

Details for the file x_wr_timezone-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: x_wr_timezone-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for x_wr_timezone-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e74a53b9f4f7def8138455c240e65e47c224778bce3c024fcd6da2cbe91ca038
MD5 745e36c90fa1411e868199f6a86e6cb4
BLAKE2b-256 0fb74bac35b4079b76c07d8faddf89467e9891b1610cfe8d03b0ebb5610e4423

See more details on using hashes here.

Supported by

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