https://github.com/scientific-python/yaml2ics
Convert YAML calendar entries to ICS
https://github.com/scientific-python/yaml2ics
Last synced: 26 days ago
JSON representation
Convert YAML calendar entries to ICS
- Host: GitHub
- URL: https://github.com/scientific-python/yaml2ics
- Owner: scientific-python
- License: bsd-3-clause
- Created: 2021-09-21T00:24:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-04T02:05:18.000Z (4 months ago)
- Last Synced: 2025-12-04T02:55:53.593Z (4 months ago)
- Language: Python
- Homepage:
- Size: 135 KB
- Stars: 22
- Watchers: 7
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/yaml2ics/)
[](https://github.com/scientific-python/yaml2ics/actions?query=workflow%3A%22test%22)
[](https://app.codecov.io/gh/scientific-python/yaml2ics/branch/main)
# YAML to iCalendar (ics)
| WARNING: this project is still in beta. Beware of breaking changes! |
| ------------------------------------------------------------------- |
Convert YAML files to .ics files which can be imported into other
calendar applications.
Features include:
- Converting single .yaml files, or combining multiple into one .ics
file.
- ics fields: name, summary, description, location, timezone, repeat
- Specify event start+end or start+duration
- Recurring events (basic support)
- All-day events
- Timezone specification (default or per-event)
## Installation
```
pip install yaml2ics
```
## Usage
To produce a calendar from a list of events:
```
python yaml2ics.py example/test_calendar.yaml
```
To combine lists of events in to a calendar:
```
python yaml2ics.py example/test_calendar.yaml example/another_calendar.yaml
```
## Syntax
Please see `example/test_calendar.yaml` for a full demo including
explanations. Below is a minimal template that shows the basic idea:
```yaml
name: Calendar Name
timezone: Europe/Helsinki # default timezone for events, optional
events:
- summary: The event title
begin: 2021-09-21 15:00:00
duration:
minutes: 30
location: |
https://meet.jit.si/example
description: |
In this meeting we will ...
```
## Timezones
The event timezone can be specified in three ways (in reverse order of precedence):
1. Using the `timezone: ...` field, as shown above under "Syntax".
2. Adding it to an individual event:
```yaml
- summary: My event
timezone: America/Los_Angeles
```
3. By specifying a timezone in the event start time:
```
2021-09-21 15:00:00 +07:00
```
Valid timezones are listed at https://datetime.app/iana-timezones
If no timezone is set, we default to UTC.
## Contributing
Contributions are welcomed! This project is still in active development
and should be considered beta.
To install the development version, fork the source of the project and make an
editable install:
```
pip install -e ".[test]"
```
To test:
```
pytest
```
Generate a coverage report with:
```
pytest --cov-report term-missing --cov yaml2ics
```
[black](https://github.com/psf/black) and other linters are used to auto-format
files (and enforced by CI). To install the git hooks, use `pre-commit install`.
To run the tests/auto-formatting manually, use `pre-commit run --all-files`.