From 2b1b01562f477368a9db6a37c8d66dc52e35ab84 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Sat, 22 Jun 2024 19:03:41 +0100 Subject: [PATCH 1/4] Update documentation for versions 3.8+ This compacts the documentation. Mentions of old versions are removed. A concise path from 5.x to 6.0 is outlined. master -> main --- README.rst | 37 +++++-------------------------------- 1 file changed, 5 insertions(+), 32 deletions(-) diff --git a/README.rst b/README.rst index 008c2313..fcc361c1 100644 --- a/README.rst +++ b/README.rst @@ -136,21 +136,8 @@ with the same result: X-DT-ZONEINFO;TZID=Europe/London:20240619T100100 END:VEVENT - - -Versions and Compatibility --------------------------- - -``icalendar`` is a critical project used by many. It has been there for a long time and maintaining -long-term compatibility with projects conflicts partially with providing and using the features that -the latest Python versions bring. - -Volunteers pour `effort into maintaining and developing icalendar -`_. -Below, you can find an overview of the versions and how we maintain them. - -Version 6 -~~~~~~~~~ +Version 6 with zoneinfo +~~~~~~~~~~~~~~~~~~~~~~~ Version 6 of ``icalendar`` switches the timezone implementation to ``zoneinfo``. This only affects you if you parse ``icalendar`` objects with ``from_ical()``. @@ -166,7 +153,7 @@ By default and since 6.0.0, ``zoneinfo`` timezones are created. ZoneInfo(key='Europe/Vienna') If you would like to continue to receive ``pytz`` timezones in as parse results, -you can receive all the latest updates, and switch back to version 5.x behavior: +you can receive all the latest updates, and switch back to earlier behavior: .. code:: python @@ -175,22 +162,8 @@ you can receive all the latest updates, and switch back to version 5.x behavior: >>> dt.tzinfo -Version 6 is on `branch master `_ with compatibility to Python versions ``3.7+`` and ``PyPy3``. -We expect the ``master`` branch with versions ``6+`` to receive the latest updates and features. - -Version 5 -~~~~~~~~~ - -Version 5 uses only the ``pytz`` timezone implementation, and not ``zoneinfo``. -No updates will be released for this. -Please use version 6 and switch to use ``zoneinfo`` as documented above. - -Version 4 -~~~~~~~~~ - -Version 4 is on `branch 4.x `_ with maximum compatibility with Python versions ``2.7`` and ``3.4+``, ``PyPy2`` and ``PyPy3``. -The ``4.x`` branch only receives security and bug fixes if someone makes the effort. -We recommend migrating to later Python versions and also providing feedback if you depend on the ``4.x`` features. +Version 6 is on `branch main `_ with compatibility to C-Python and PyPy3. +We expect the ``main`` branch with versions ``6+`` to receive the latest updates and features. Related projects ================ From abcd4c668a20c9a07a27b442a7c502d5216a6888 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Sat, 22 Jun 2024 19:06:45 +0100 Subject: [PATCH 2/4] log changes --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 98cc95b0..90735beb 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -42,7 +42,7 @@ New features: Bug fixes: -- ... +- Change documentation to represent compatibility to Python 3.8+ and PyPy3 5.0.13 (2024-06-20) ------------------- From f75a179bfb1cd4b2a6e5aa8154f7e4c4db9f7e29 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Sun, 23 Jun 2024 14:38:18 +0100 Subject: [PATCH 3/4] Update README.rst Co-authored-by: Steve Piercy --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index fcc361c1..837125e8 100644 --- a/README.rst +++ b/README.rst @@ -162,7 +162,8 @@ you can receive all the latest updates, and switch back to earlier behavior: >>> dt.tzinfo -Version 6 is on `branch main `_ with compatibility to C-Python and PyPy3. +Version 6 is on `branch main `_. +It is compatible with Python versions 3.7 - 3.11, and PyPy3. We expect the ``main`` branch with versions ``6+`` to receive the latest updates and features. Related projects From b340a236aba942672d5ef62910a7b319416b6f27 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 24 Jun 2024 16:39:34 -0700 Subject: [PATCH 4/4] Resolve Python version inconsistency with issue title and change log entry --- CHANGES.rst | 2 +- README.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index ab803aab..06b594e5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -52,7 +52,7 @@ New features: Bug fixes: -- Change documentation to represent compatibility to Python 3.8+ and PyPy3 +- Change documentation to represent compatibility with Python 3.8 - 3.12, and PyPy3. - Rename RFC 2445 to RFC 5545, see `Issue 278 `_ diff --git a/README.rst b/README.rst index a1e3cbaf..4f842e3f 100644 --- a/README.rst +++ b/README.rst @@ -166,7 +166,7 @@ you can receive all the latest updates, and switch back to earlier behavior: Version 6 is on `branch main `_. -It is compatible with Python versions 3.7 - 3.11, and PyPy3. +It is compatible with Python versions 3.8 - 3.12, and PyPy3. We expect the ``main`` branch with versions ``6+`` to receive the latest updates and features. Related projects