File: index.md

package info (click to toggle)
python-recurring-ical-events 3.8.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,584 kB
  • sloc: python: 4,476; makefile: 84
file content (70 lines) | stat: -rw-r--r-- 1,507 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
---
myst:
  html_meta:
    "description lang=en": |
      Documentation for users who wish query calendars for occurrences of events and other components.
---

# Get started

This section gets you started using this library.

## Installation

```{eval-rst}
.. tabs::

   .. tab:: Pip

      .. code-block:: bash

          pip install 'recurring-ical-events==3.*'

   .. tab:: Debian/Ubuntu

      .. code-block:: bash

          sudo apt-get install python-recurring-ical-events

   .. tab:: Alpine Linux

      .. code-block:: bash

          apk add py3-recurring-ical-events

   .. tab:: Fedora

      .. code-block:: bash

        sudo dnf install ???

   .. tab:: Arch Linux

      .. code-block:: bash

        ???


```

If not listed, this library is available as a package on the following platforms:

[![Packaging status](https://repology.org/badge/vertical-allrepos/python%3Arecurring-ical-events.svg?columns=3)](https://repology.org/project/python%3Arecurring-ical-events/versions)

## Usage

The [icalendar] module is responsible for parsing files with a calendar specification in it.
This library takes such a {py:class}`icalendar.cal.Calendar` and computes the occurrences.

To import this module, write

```python
>>> import recurring_ical_events

```

If you like to go deeper, have a look at the [API documentation](../reference/api) at this point.
We have a comprehensive list of **[examples]** to get you started.

[icalendar]: https://icalendar.readthedocs.io
[examples]: examples.rst