Merge branch 'main' into ruff-tests

.github/workflows/tests.yml

@@ -25,6 +25,7 @@ jobs:
 #        - ["3.10",  "docs"]  # disable as readthedocs builds it
         - ["3.11",  "py311"]
         - ["3.12",  "py312"]
+        - ["3.13",  "py313"]
 
     runs-on: ubuntu-latest
     name: ${{ matrix.config[1] }}
@@ -79,7 +80,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
+        python-version: "3.13"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -111,7 +112,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
+        python-version: "3.13"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

CHANGES.rst

@@ -1,24 +1,38 @@
 Changelog
 =========
 
-6.0.1 (unreleased)
+6.0.2 (unreleased)
 ------------------
 
 Minor changes:
 
 - Format test code with Ruff. See `Issue 672 <https://github.com/collective/icalendar/issues/672>`_.
+- Document the Debian package. See `Issue 701 <https://github.com/collective/icalendar/issues/701>`_.
 
 Breaking changes:
 
 - ...
 
 New features:
 
+- Add ``VALARM`` properties for :rfc:`9074`. See `Issue 657 <https://github.com/collective/icalendar/issues/657>`_
+- Test compatibility with Python 3.13
+
+Bug fixes:
+
 - ...
 
+6.0.1 (2024-10-13)
+------------------
+
+New features:
+
+- Added ``Event.end``, ``Event.start``, ``Event.dtstart``, and ``Event.dtend`` attributes. See `Issue 662 <https://github.com/collective/icalendar/issues/662>`_.
+
 Bug fixes:
 
 - Fix a few ``__all__`` variables.
+- Added missing ``docs`` folder to distribution packages. See `Issue 712 <https://github.com/collective/icalendar/issues/712>`_.
 
 6.0.0 (2024-09-28)
 ------------------
@@ -439,7 +453,6 @@ Bug fixes:
 
 - Use ``vText`` as default type, when convert recurrence definition to ical string. [kam193]
 
-
 4.0.5 (2020-03-21)
 ------------------
 

README.rst

@@ -2,15 +2,15 @@
 Internet Calendaring and Scheduling (iCalendar) for Python
 ==========================================================
 
-The `icalendar`_ package is a `RFC 5545`_ compatible parser/generator for iCalendar
+The `icalendar`_ package is a :rfc:`5545` compatible parser/generator for iCalendar
 files.
 
 ----
 
 :Homepage: https://icalendar.readthedocs.io
 :Code: https://github.com/collective/icalendar
 :Mailing list: https://github.com/collective/icalendar/issues
-:Dependencies: `python-dateutil`_ and `pytz`_.
+:Dependencies: `python-dateutil`_ and `tzdata`_.
 :License: `BSD`_
 
 ----
@@ -41,9 +41,8 @@ files.
 
 
 .. _`icalendar`: https://pypi.org/project/icalendar/
-.. _`RFC 5545`: https://www.ietf.org/rfc/rfc5545.txt
 .. _`python-dateutil`: https://github.com/dateutil/dateutil/
-.. _`pytz`: https://pypi.org/project/pytz/
+.. _`tzdata`: https://pypi.org/project/tzdata/
 .. _`BSD`: https://github.com/collective/icalendar/issues/2
 
 Quick start guide
@@ -96,7 +95,7 @@ Create Events, TODOs, Journals, Alarms, ...
 -------------------------------------------
 
 ``icalendar`` supports the creation and parsing of all kinds of objects
-in the iCalendar (RFC 5545) standard.
+in the iCalendar (:rfc:`5545`) standard.
 
 .. code:: python
 
@@ -169,15 +168,15 @@ you can receive all the latest updates, and switch back to earlier behavior:
     <DstTzInfo 'Europe/Vienna' CET+1:00:00 STD>
 
 Version 6 is on `branch main <https://github.com/collective/icalendar/>`_.
-It is compatible with Python versions 3.8 - 3.12, and PyPy3.
+It is compatible with Python versions 3.8 - 3.13, and PyPy3.
 We expect the ``main`` branch with versions ``6+`` to receive the latest updates and features.
 
 Related projects
 ================
 
 * `icalevents <https://github.com/irgangla/icalevents>`_. It is built on top of icalendar and allows you to query iCal files and get the events happening on specific dates. It manages recurrent events as well.
 * `recurring-ical-events <https://pypi.org/project/recurring-ical-events/>`_. Library to query an ``ICalendar`` object for events happening at a certain date or within a certain time.
-* `x-wr-timezone <https://pypi.org/project/x-wr-timezone/>`_. Library to make ``ICalendar`` objects and files using the non-standard ``X-WR-TIMEZONE`` compliant with the standard (RFC 5545).
+* `x-wr-timezone <https://pypi.org/project/x-wr-timezone/>`_. Library to make ``ICalendar`` objects and files using the non-standard ``X-WR-TIMEZONE`` compliant with the standard (:rfc:`5545`).
 
 Further Reading
 ===============

docs/install.rst

@@ -1,6 +1,11 @@
 Installing iCalendar
 ====================
 
+You can install ``icalendar`` in several ways.
+
+Python Package with ``pip``
+---------------------------
+
 To install the icalendar package, use:
 
 .. code-block:: shell
@@ -14,6 +19,16 @@ package, like this:
 
     >>> import icalendar
 
+Debian or Ubuntu
+----------------
+
+You can install the `python-icalendar package <https://tracker.debian.org/pkg/python-icalendar>`_
+for Debian or its derivatives.
+
+.. code-block:: shell
+
+    sudo apt-get install python3-icalendar
+
 Development Setup
 -----------------
 

docs/maintenance.rst

@@ -148,3 +148,16 @@ This section contains useful links for maintainers and collaborators:
 
 - `Future of icalendar, looking for maintainer #360 <https://github.com/collective/icalendar/discussions/360>`__
 - `Comment on the Plone tests running with icalendar <https://github.com/collective/icalendar/pull/447#issuecomment-1277643634>`__
+
+Updating Python Versions
+------------------------
+
+When adding support for a new Python version or removing support for an old one, the following files need to be updated:
+
+1. ``.github/workflows/tests.yml``: Add or remove the Python version from the test matrix.
+2. ``tox.ini``: Update the ``envlist`` to include or remove the Python version.
+3. ``pyproject.toml``: Update the ``requires-python`` line and the ``classifiers`` list.
+4. ``README.rst``: Update the compatibility information.
+5. ``docs/maintenance.rst``: Update this list if any new files need to be modified.
+
+Remember to test the changes thoroughly and update any documentation that mentions supported Python versions.

docs/usage.rst

@@ -12,18 +12,18 @@ Compatibility
 
 This package is compatible with the following standards:
 
-- :rfc:`5545`
-- :rfc:`7529`
-
-We do not claim compatibility to:
-
-- :rfc:`2445` - which is obsoleted by :rfc:`5545`
-- :rfc:`6886`
-- :rfc:`7953`
-- :rfc:`7986`
-- :rfc:`9073`
-- :rfc:`9074`
-- :rfc:`9253`
+- :rfc:`5545` - Internet Calendaring and Scheduling Core Object Specification (iCalendar)
+- :rfc:`7529` - Non-Gregorian Recurrence Rules in the Internet Calendaring and Scheduling Core Object Specification (iCalendar)
+- :rfc:`9074` - "VALARM" Extensions for iCalendar
+
+We do not claim compatibility to the following RFCs. They might work though.
+
+- :rfc:`2445` - obsoleted by :rfc:`5545`
+- :rfc:`6868` - Parameter Value Encoding in iCalendar and vCard
+- :rfc:`7953` - Calendar Availability
+- :rfc:`7986` - New Properties for iCalendar
+- :rfc:`9073` - Event Publishing Extensions to iCalendar
+- :rfc:`9253` - Support for iCalendar Relationships
 
 File structure
 --------------

pyproject.toml

@@ -65,6 +65,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -93,7 +94,6 @@ exclude = [
   "/.*",
   "/*.*",
   "/src/icalendar/fuzzing",
-  "/docs",
   "/dist",
   "/build",
   "/htmlcov",
@@ -157,6 +157,7 @@ ignore = [
     "PERF401", # Use a list comprehension to create a transformed list
     "ARG002",  # Unused method argument: ...
     "ARG001",  # Unused function argument: ...
+    "UP007",   # Optional -> X | None remove when migrated to py39+
 ]
 extend-safe-fixes = [
     "PT006", # Wrong type passed to first argument of @pytest.mark.parametrize; expected {expected_string}

src/icalendar/__init__.py

@@ -5,6 +5,8 @@
     ComponentFactory,
     Event,
     FreeBusy,
+    IncompleteComponent,
+    InvalidCalendar,
     Journal,
     Timezone,
     TimezoneDaylight,
@@ -34,6 +36,7 @@
     vFrequency,
     vGeo,
     vInt,
+    vMonth,
     vPeriod,
     vRecur,
     vText,
@@ -88,4 +91,7 @@
     "version_tuple",
     "TypesFactory",
     "Component",
+    "vMonth",
+    "IncompleteComponent",
+    "InvalidCalendar",
 ]