cal-ics2md

Markdown Calendar Generator

View your .ics calendars as monthly calendar in Markdown format!

Features

• Generate a monthly calendar in Markdown format from .ics files
• Supports general .ics files
• Events of the day in dropdown format
• Customizable event formatting and detail

Usage

Installation and Dependencies

This script requires Python and the following packages:

• icalendar
• pyyaml

Copy/download this repository. For git users:

git clone https://github.com/cc-christopher/cal-ics2md.git

Install the required packages:

pip install icalendar
pip install pyyaml

Configuration and Running

1. Navigate to the cal-ics2md directory and open the config.yaml file.

2. Paste the link to the .ics file after the CALENDAR_URL key.

3. Set your desired period between START_MONTH / START_YEAR and END_MONTH / END_YEAR.

4. Set your desired output file naming. Default is calendar.md.

5. On the same directory, run the script from the terminal:

   python cal-ics2md.py

6. Done! Have a cookie! 🍪

Customization

The current program is set for Bahasa Indonesia output. You can customize the bulan variable to change the month to your desired language. For days of the week, you can customize the weekheader() function.

To customize the event formatting, please modify to generate_event() function. Don't forget that the df variable needs to reflect additional columns you provided.

⚠️ Warning: Some .ics files may have different parameters which affects the DataFrame columns. Please check the .ics file and modify the generate_event() function and columns accordingly.

For example, the first .ics file has a LOCATION parameter, while the second .ics file does not.

An .ics file with LOCATION parameter.

An .ics file **without** LOCATION parameter.

To-Do

• Add support for multiple .ics files
• Add multi-language support
• Reflect DataFrame column and generate_event() properties directly from parameters of the .ics file

Repository Information

Author: cc-christopher https://github.com/cc-christopher GPL-3.0 License