icalendar

https://icalendar.readthedocs.io/en/stable/
Admin
An RFC 5545 compatible Python parser and generator for creating, inspecting, and modifying Internet...
Tokens:177,580
Snippets:1,755
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Provide vDDDTypes examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/types.html

Returns a list of example vDDDTypes instances.

```python
@classmethod
def examples(cls) -> list[vDDDTypes]:
    """Examples of vDDDTypes."""
    return [cls(date(2025, 11, 10)), cls(timedelta(days=1, hours=5))]
```

--------------------------------

### Define vPeriod examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/period.html

Returns a list of example vPeriod instances.

```python
@classmethod
def examples(cls) -> list[Self]:
    """Examples of vPeriod."""
    return [
        vPeriod((datetime(2025, 11, 10, 16, 35), timedelta(hours=1, minutes=30))),
        vPeriod((datetime(2025, 11, 10, 16, 35), datetime(2025, 11, 10, 18, 5))),
    ]
```

--------------------------------

### Retrieve a Todo example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/todo.html

The example class method fetches a predefined Todo instance by name from the internal example store.

```python
@classmethod
def example(cls, name: str = "example") -> Todo:
    """Return the todo example with the given name."""
    return cls.from_ical(get_example("todos", name))
```

--------------------------------

### Retrieve a timezone example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/timezone.html

Use the example class method to load a predefined VTIMEZONE example by name.

```python
@classmethod
def example(cls, name: str = "pacific_fiji") -> Calendar:
    """Return the timezone example with the given name."""
    return cls.from_ical(get_example("timezones", name))
```

--------------------------------

### Retrieve vTime examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/time.html

Returns a list of example vTime instances.

```python
    @classmethod
    def examples(cls) -> list[Self]:
        """Examples of vTime."""
        return [cls(time(12, 30))]
```

--------------------------------

### Get vRecur Examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/recur/recur.html

Returns a list of example vRecur instances.

```python
@classmethod
def examples(cls) -> list[Self]:
    """Examples of vRecur."""
    return [cls.from_ical("FREQ=DAILY;COUNT=10")]
```

--------------------------------

### Install development environment

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/development.rst.txt

Installs all dependencies, creates a virtual environment, and sets up pre-commit hooks.

```shell
make dev
```

--------------------------------

### Retrieve an Availability example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/availability.html

Retrieves a predefined Availability example by name, defaulting to the RFC 7953 example.

```python
@classmethod
def example(cls, name: str = "rfc_7953_1") -> Availability:
    """Return the calendar example with the given name."""
    return cls.from_ical(get_example("availabilities", name))
```

--------------------------------

### Generate vOrg Examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/org.html

Returns a list of example vOrg instances.

```python
    @classmethod
    def examples(cls) -> list[Self]:
        """Examples of vOrg."""
        return [cls(("ABC Inc.", "North American Division", "Marketing"))]
```

--------------------------------

### Contentline parts example with parameters

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.parser.content_line.html

Example of a content line containing parameters.

```text
DESCRIPTION;ALTREP="cid:part1.0001@example.org":The Fall'98 Wild
```

--------------------------------

### get_example(component_directory, example_name)

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.cal.examples.html

Retrieves a specific example component from the provided directory. Raises an error if the requested example does not exist.

```APIDOC
## get_example(component_directory, example_name)

### Description
Retrieves an example component from the specified directory. If the example is not found, an error is raised.

### Parameters
- **component_directory** (str) - The directory path containing the component examples.
- **example_name** (str) - The name of the specific example to retrieve.

### Returns
- **bytes** - The content of the requested example.
```

--------------------------------

### classmethod example(name='rfc_9074_example_3')

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.cal.event.html

Returns a calendar example object with the specified name.

```APIDOC
## classmethod example(name='rfc_9074_example_3')

### Description
Returns the calendar example with the given name.

### Parameters
- **name** (str) - Optional - The name of the example to retrieve. Defaults to 'rfc_9074_example_3'.

### Returns
- **Event** - The requested calendar event example.
```

--------------------------------

### Retrieve example component file

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/examples.html

Fetches an example file as bytes from the test directory. Raises a ValueError if the specified file does not exist.

```python
"""Access to examples of components."""

from __future__ import annotations

from pathlib import Path




[docs]
def get_example(component_directory: str, example_name: str) -> bytes:
    """Return an example and raise an error if it is absent."""
    here = Path(__file__).parent.parent
    examples = here / "tests" / component_directory
    if not example_name.endswith(".ics"):
        example_name = example_name + ".ics"
    example_file = examples / example_name
    if not example_file.is_file():
        raise ValueError(
            f"Example {example_name} for {component_directory} not found. "
            f"You can use one of {', '.join(p.name for p in examples.iterdir())}"
        )
    return Path(example_file).read_bytes()




__all__ = ["get_example"]
```

--------------------------------

### Define vDuration examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/duration.html

Returns a list of example vDuration instances.

```python
    @classmethod
    def examples(cls) -> list[Self]:
        """Examples of vDuration."""
        return [cls(timedelta(1, 99))]
```

--------------------------------

### vUid.examples()

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/uid.html

Returns a list of example vUid instances.

```APIDOC
## vUid.examples()

### Description
Provides a list of example vUid instances for reference.

### Signature
`@classmethod def examples(cls) -> list[Self]`

### Returns
- **list[vUid]** - A list containing example vUid objects.
```

--------------------------------

### Generate vN Examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/n.html

Provides a list of example vN instances for testing or documentation purposes.

```python
    @classmethod
    def examples(cls) -> list[Self]:
        """Examples of vN."""
        return [cls(("Doe", "John", "M.", "Dr.", "Jr."))]
```

--------------------------------

### Retrieve Available Component Example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/available.html

Retrieves a predefined calendar example by name for testing or demonstration purposes.

```python
@classmethod
    def example(cls, name: str = "rfc_7953_1") -> Available:
        """Return the calendar example with the given name."""
        return cls.from_ical(get_example("availabilities", name)).available[0]
```

--------------------------------

### Install icalendar with pip

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Standard command to install the package using pip.

```shell
pip install icalendar
```

--------------------------------

### PRODID property example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/calendar.html

Example of a product identifier string.

```text
-//ABC Corporation//NONSGML My Product//EN
```

--------------------------------

### Retrieve Alarm Example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/alarm.html

Retrieves a predefined alarm example by name.

```python
@classmethod
def example(cls, name: str = "example") -> Alarm:
    """Return the alarm example with the given name."""
    return cls.from_ical(get_example("alarms", name))
```

--------------------------------

### Example integer values

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/integer.html

Examples of valid integer strings as defined by the specification.

```text
1234567890
-1234567890
+1234567890
432109876
```

--------------------------------

### Todo.example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/todo.html

Retrieves a pre-defined example of a Todo object.

```APIDOC
## Todo.example

### Description
Returns a Todo example object based on the provided name.

### Parameters
- **name** (str) - Optional - The name of the example to retrieve (defaults to "example").

### Returns
- **Todo** - The requested Todo example object.
```

--------------------------------

### Install uv on Windows

Source: https://icalendar.readthedocs.io/en/stable/contribute/documentation/build-check.html

Use this PowerShell command to install uv on native Windows environments.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

--------------------------------

### Install uv on macOS, Linux, and Windows with WSL

Source: https://icalendar.readthedocs.io/en/stable/contribute/documentation/build-check.html

Use this command to install uv on Unix-like systems or Windows Subsystem for Linux.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### Install icalendar on NixOS

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Use the nix-env command to install the package from the nixpkgs repository.

```shell
nix-env -iA nixpkgs.python3Packages.icalendar
```

--------------------------------

### Example FLOAT values

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/float.html

Examples of valid FLOAT values as specified in the RFC.

```text
1000000.0000001
1.333
-3.14
```

--------------------------------

### Contentline parts example without parameters

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.parser.content_line.html

Example of a simple content line without parameters.

```text
DESCRIPTION:The Fall'98 Wild
```

--------------------------------

### Calendar.example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/calendar.html

Retrieves a pre-defined calendar example by name.

```APIDOC
## Calendar.example(name: str = "example")

### Description
Returns a calendar instance based on a pre-defined example.

### Parameters
- **name** (str) - Optional - The name of the example to retrieve. Defaults to "example".
```

--------------------------------

### Alarm.example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/alarm.html

Retrieves a pre-defined alarm example by name.

```APIDOC
## Alarm.example

### Description
Returns an alarm example object based on the provided name.

### Parameters
- **name** (str) - Optional - The name of the example to retrieve (defaults to 'example').

### Returns
- **Alarm** - The requested Alarm instance.
```

--------------------------------

### Install icalendar with pytz dependency

Source: https://icalendar.readthedocs.io/en/stable/reference/changelog.html

Use this command to install icalendar while explicitly including pytz as a dependency.

```bash
pip install icalendar==6.* pytz
```

--------------------------------

### Change log filename examples

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/index.rst.txt

Examples of valid filenames for change log entries, including issue-linked files and orphan entries.

```text
1158.documentation
1158.documentation.1
1158.documentation.2
```

```text
+anything.bugfix
```

--------------------------------

### Event.example(name)

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/event.html

Retrieves a pre-defined calendar event example by its name.

```APIDOC
## Event.example(name)

### Description
Returns a calendar example event based on the provided name identifier.

### Parameters
- **name** (str) - Optional - The name of the example to retrieve (defaults to 'rfc_9074_example_3').

### Example
```python
from icalendar import Event
event = Event.example("rfc_9074_example_1")
```
```

--------------------------------

### Start live HTML preview

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/documentation/build-check.rst.txt

Rebuilds documentation automatically upon file changes and provides a local URL for browser preview.

```shell
make livehtml
```

```console
[sphinx-autobuild] Serving on http://127.0.0.1:8050
```

--------------------------------

### Identify calendar format in logs

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/fuzz-testing.rst.txt

Example of the start and end delimiters used to wrap base64-encoded calendar data in log files.

```text
--- start calendar ---
QkVHSU46CkJpaWloOgpCaWlpMDoKRU5kOg==
--- end calendar ---
```

--------------------------------

### View uncaught exception log

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/fuzz-testing.rst.txt

Example of a Python traceback log entry.

```text
--- start calendar ---
=== Uncaught Python exception: ===
ValueError: Invalid month: ''
Traceback (most recent call last):
```

--------------------------------

### Configure Sphinx extension

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/documentation/build-check.rst.txt

Example configuration for the Napoleon extension in docs/conf.py.

```python
# -- Napolean configuration ----------------------------------
napoleon_use_param = True
napoleon_google_docstring = True
napoleon_attr_annotations = True
```

--------------------------------

### Execute Main with Multiple Implementations

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/timezone/equivalent_timezone_ids.html

Example usage of the main function using ZoneInfo, pytz, and dateutil.

```python
if __name__ == "__main__":
    from zoneinfo import ZoneInfo

    from dateutil.tz import gettz
    from pytz import timezone

    # add more timezone implementations if you like
    main(
        [ZoneInfo, timezone, gettz],
        "result",
    )
```

--------------------------------

### Display CLI help

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/cli.rst.txt

Use the -h flag to list all available commands and options.

```shell
icalendar -h
```

--------------------------------

### Create vCalAddress instances

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/cal_address.html

Demonstrates basic instantiation and setting parameters for a calendar address.

```python
>>> from icalendar.prop import vCalAddress
>>> addr = vCalAddress.new("test@test.com")
>>> str(addr)
'mailto:test@test.com'
```

```python
>>> addr = vCalAddress.new("test@test.com", cn="Test User", role="CHAIR")
>>> addr.params["CN"]
'Test User'
>>> addr.params["ROLE"]
'CHAIR'
```

--------------------------------

### Display help for Make commands

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/documentation/build-check.rst.txt

Lists all available documentation build and check commands defined in the Makefile.

```shell
make help
```

--------------------------------

### Accessing Availability via Python

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/availability.html

Demonstrates how to instantiate an Availability object and access its properties using the library's example method.

```pycon
>>> from icalendar import Availability
>>> a = Availability.example()
>>> a.organizer
vCalAddress('mailto:bernard@example.com')
```

--------------------------------

### Access Available component via Python

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/available.html

Retrieving an example Available component and accessing its properties.

```pycon
>>> from icalendar import Available
>>> a = Available.example()
>>> str(a.summary)
'Monday to Friday from 9:00 to 17:00'
```

--------------------------------

### CONCEPT ICS Example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/attr.html

An example of the CONCEPT property pointing to an external resource.

```ics
CONCEPT:https://example.com/event-types/arts/music
```

--------------------------------

### LINK Property Examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/attr.html

Examples of the LINK property serialization in iCalendar format.

```ics
LINK;LINKREL=SOURCE;LABEL=Venue;VALUE=URI:
 https://example.com/events
```

```ics
LINK;LINKREL="https://example.com/linkrel/derivedFrom";
 VALUE=URI:
 https://example.com/tasks/01234567-abcd1234.ics
```

```ics
LINK;LINKREL="https://example.com/linkrel/costStructure";
 VALUE=XML-REFERENCE:
 https://example.com/xmlDocs/bidFramework.xml
 #xpointer(descendant::CostStruc/range-to(
 following::CostStrucEND[1]))
```

--------------------------------

### View live server output

Source: https://icalendar.readthedocs.io/en/stable/contribute/documentation/build-check.html

Example console output indicating the local server address.

```text
[sphinx-autobuild] Serving on http://127.0.0.1:8050
```

--------------------------------

### get_example(component_directory: str, example_name: str) -> bytes

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/examples.html

Retrieves the content of a specific iCalendar example file. If the file name does not end in .ics, the extension is automatically appended.

```APIDOC
## get_example(component_directory, example_name)

### Description
Retrieves the raw bytes of an example iCalendar file from the library's test suite directory. If the provided example name lacks the .ics extension, it is appended automatically.

### Parameters
- **component_directory** (str) - Required - The subdirectory within the tests folder where the example is located.
- **example_name** (str) - Required - The name of the example file to retrieve.

### Returns
- **bytes** - The content of the requested example file.

### Errors
- **ValueError** - Raised if the specified example file does not exist in the target directory.
```

--------------------------------

### Example iCalendar duration strings

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/duration.html

Examples of valid iCalendar duration strings.

```ics
P15DT5H0M20S
```

```ics
P7W
```

--------------------------------

### Define vDatetime examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/datetime.html

Class method to return example instances of vDatetime.

```python
@classmethod
def examples(cls) -> list[Self]:
    """Examples of vDatetime."""
    return [cls(datetime(2025, 11, 10, 16, 52))]
```

--------------------------------

### Initialize Calendar and Add Properties

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/usage.rst.txt

Basic setup for a new calendar object compliant with RFC 5545.

```pycon
>>> cal = Calendar()
>>> from datetime import datetime
>>> import zoneinfo
```

```pycon
>>> cal.add("prodid", "-//My calendar product//mxm.dk//")
>>> cal.add("version", "2.0")
```

--------------------------------

### Initialize an Availability component

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/availability.html

This snippet demonstrates the internal logic for creating a new Availability instance, including setting default values for UID and timestamp, and validating start/end times.

```python
availability: Availability = super().new(
    stamp=stamp if stamp is not None else cls._utc_now(),
    created=created,
    comments=comments,
    last_modified=last_modified,
    links=links,
    related_to=related_to,
    refids=refids,
    concepts=concepts,
    subcomponents=subcomponents,
)
availability.summary = summary
availability.description = description
availability.uid = uid if uid is not None else uuid.uuid4()
availability.sequence = sequence
availability.categories = categories
availability.classification = classification
availability.url = url
availability.busy_type = busy_type
availability.organizer = organizer
availability.location = location
availability.priority = priority
availability.contacts = contacts
for subcomponent in components:
    availability.add_component(subcomponent)
if cls._validate_new:
    if start is not None and (
        not isinstance(start, datetime) or start.tzinfo is None
    ):
        raise InvalidCalendar(
            "Availability start must be a datetime with a timezone"
        )
    if end is not None and (
        not isinstance(end, datetime) or end.tzinfo is None
    ):
        raise InvalidCalendar(
            "Availability end must be a datetime with a timezone"
        )
    availability._validate_start_and_end(start, end)
availability.start = start
availability.end = end
return availability
```

--------------------------------

### Event.new(start)

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/event.html

Creates a new Event instance with a specified start time.

```APIDOC
## Event.new(start)

### Description
Creates a new Event object initialized with a start date/time.

### Parameters
- **start** (datetime) - Required - The start date and time for the event.

### Example
```python
from icalendar import Event
from datetime import datetime
event = Event.new(start=datetime(2021, 1, 1, 12, 30, 0))
```
```

--------------------------------

### RFC 5545 RELATED-TO Examples

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.cal.component.html

Examples of the RELATED-TO property as defined in RFC 5545.

```text
RELATED-TO:jsmith.part7.19960817T083000.xyzMail@example.com
```

```text
RELATED-TO:19960401-080045-4000F192713-0052@example.com
```

--------------------------------

### UTC time example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/time.html

An example of an absolute time value using the UTC designator.

```ics
070000Z
```

--------------------------------

### Retrieve and Instantiate Components

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/component_factory.html

Demonstrates how to use the ComponentFactory to retrieve a standard component class and instantiate it.

```pycon
>>> from icalendar import ComponentFactory
>>> factory = ComponentFactory()
>>> event_class = factory.get_component_class('VEVENT')
>>> event_class()
VEVENT({})
```

--------------------------------

### Example CLI output

Source: https://icalendar.readthedocs.io/en/stable/how-to/cli.html

Sample output format displayed when reading an iCalendar file.

```text
Organiser: Secretary <secretary@company.com>
Attendees:
  John Doe <j.doe@company.com>
  Randy <boss@company.com>
Summary: Yearly evaluation.
When: Tue 14 Mar 2017 11:00-12:00
Location: Randy's office
Comment: Reminder.
Description:

Your yearly evaluation is scheduled for next Tuesday. Please be on time.
```

--------------------------------

### Install icalendar on Fedora

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Use the dnf package manager to install the python3-icalendar package.

```shell
sudo dnf install python3-icalendar
```

--------------------------------

### Verify icalendar installation

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Check if the package is correctly installed by importing it in a Python interpreter.

```pycon
>>> import icalendar
```

--------------------------------

### RELATED-TO ICS Examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/attr.html

Examples of the RELATED-TO property as defined in RFC 5545 and RFC 9253.

```ics
RELATED-TO:jsmith.part7.19960817T083000.xyzMail@example.com
```

```ics
RELATED-TO:19960401-080045-4000F192713-0052@example.com
```

```ics
RELATED-TO;VALUE=URI;RELTYPE=STARTTOFINISH:
 https://example.com/caldav/user/jb/cal/
 19960401-080045-4000F192713.ics
```

--------------------------------

### Change log entry content examples

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/index.rst.txt

Examples of well-formatted and poorly-formatted change log entries.

```rst
Created a :meth:`~icalendar.prop.recur.weekday.vWeekday.ical_value` property for the :class:`~icalendar.prop.recur.weekday.vWeekday` component, mirroring the existing pattern on :class:`~icalendar.prop.boolean.vBoolean`. @mvanhorn
```

```rst
Fix #123456 by chaning config of file [did_not_read_this_guide]
```

--------------------------------

### Invalid TIME format example

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/dt/time.html

An example of an invalid time format using a UTC offset.

```ics
230000-0800        ;Invalid time format
```

--------------------------------

### Initialize and inspect vMonth objects

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/recur/month.html

Demonstrates creating vMonth instances with standard integers or leap month strings and checking the leap property.

```pycon
>>> from icalendar import vMonth
>>> vMonth(1) # first month January
vMonth('1')
>>> vMonth("5L") # leap month in Hebrew calendar
vMonth('5L')
>>> vMonth(1).leap
False
>>> vMonth("5L").leap
True
```

--------------------------------

### Retrieve vAdr examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/prop/adr.html

Returns a list of example vAdr instances for testing or demonstration purposes.

```python
@classmethod
def examples(cls) -> list[Self]:
    """Examples of vAdr."""
    return [cls(("", "", "123 Main St", "Springfield", "IL", "62701", "USA"))]
```

--------------------------------

### Define iCalendar content line examples

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/parser/content_line.html

Examples of iCalendar content lines with and without parameters.

```ics
DESCRIPTION;ALTREP="cid:part1.0001@example.org":The Fall'98 Wild
```

```ics
DESCRIPTION:The Fall'98 Wild
```

--------------------------------

### Configure Timezone Implementation

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/usage.rst.txt

Shows how to verify the default zoneinfo implementation and how to revert to pytz if necessary.

```pycon
>>> dt = icalendar.Calendar.example("timezoned").events[0].start
>>> dt.tzinfo
ZoneInfo(key='Europe/Vienna')
```

```pycon
>>> icalendar.use_pytz()
>>> dt = icalendar.Calendar.example("timezoned").events[0].start
>>> dt.tzinfo
<DstTzInfo 'Europe/Vienna' CET+1:00:00 STD>
```

--------------------------------

### Install icalendar on Debian or Ubuntu

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Use the apt-get package manager to install the python3-icalendar package.

```shell
sudo apt-get install python3-icalendar
```

--------------------------------

### Build static HTML documentation

Source: https://icalendar.readthedocs.io/en/stable/_sources/contribute/documentation/build-check.rst.txt

Generates static HTML files in the _build/html directory.

```shell
make html
```

--------------------------------

### Install icalendar on Alpine Linux

Source: https://icalendar.readthedocs.io/en/stable/_sources/how-to/install.rst.txt

Use the apk package manager to install the py3-icalendar package.

```shell
sudo apk add py3-icalendar
```

--------------------------------

### Initialize and Populate Calendar

Source: https://icalendar.readthedocs.io/en/stable/explanation/api-design.html

Demonstrates creating a calendar object and adding properties using the add() method.

```python
>>> from icalendar import Calendar
>>> calendar = Calendar()  # create and empty calendar
>>> calendar.add("prodid", "-//My calendar product//mxm.dk//")
>>> calendar.add("version", "2.0")
>>> print(calendar.to_ical())
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//My calendar product//mxm.dk//
END:VCALENDAR
```

--------------------------------

### iCalendar Component Structure Examples

Source: https://icalendar.readthedocs.io/en/stable/_sources/explanation/api-design.rst.txt

Examples showing the nesting of VEVENT subcomponents within a VCALENDAR component.

```ics
BEGIN:VCALENDAR
... vcalendar properties ...
END:VCALENDAR
```

```ics
BEGIN:VCALENDAR
... vcalendar properties ...
BEGIN:VEVENT
... vevent properties ...
END:VEVENT
END:VCALENDAR
```

--------------------------------

### Create a VALARM component

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/alarm.html

Demonstrates creating an alarm instance and serializing it to the iCalendar format.

```pycon
>>> from icalendar import Alarm
>>> alarm = Alarm.example()
>>> print(alarm.to_ical().decode())
BEGIN:VALARM
ACTION:AUDIO
ATTACH;FMTTYPE=audio/basic:ftp://example.com/pub/sounds/bell-01.aud
DURATION:PT15M
REPEAT:4
TRIGGER;VALUE=DATE-TIME:19970317T133000Z
END:VALARM
```

--------------------------------

### set_start(start, locked=None)

Source: https://icalendar.readthedocs.io/en/stable/reference/api/icalendar.cal.event.html

Sets the start time of the event while keeping the duration or end time unchanged.

```APIDOC
## set_start(start, locked=None)

### Description
Set the start and keep the duration or end of the event.

### Parameters
- **start** (date | datetime) - Required - The start time to set
- **locked** (Literal['duration', 'end'] | None) - Optional - Which property to keep unchanged ('duration', 'end', or None for auto-detect)
```

--------------------------------

### Register a custom component

Source: https://icalendar.readthedocs.io/en/stable/_modules/icalendar/cal/component.html

Demonstrates how to subclass Component and register it using the Component.register method.

```python
>>> from icalendar import Component
>>> class XExample(Component):
...     name = "X-EXAMPLE"
...     def custom_method(self):
...         return "custom"
>>> Component.register(XExample)
```
Tokens:
Raw