django-ical

What it is and what it does

django-ical extends Django's built-in syndication feed framework to generate iCalendar feeds instead of RSS or Atom. It wraps the icalendar library and allows you to define feed classes that map Django model instances to calendar events, to-do items, or other iCalendar components. You declare which model fields map to iCalendar properties (start time, end time, location, attendees, recurrence rules, alarms, etc.) and django-ical handles serialization to RFC 5545 format.

The package is designed for developers already familiar with Django's syndication framework—the API mirrors it closely. It supports modern iCalendar features including VTODO elements, VALARM (alarms), recurring events via rrule/exrule, categories, and the full RFC 5545 property set. It runs on Python 3.8–3.11 and Django 3.2–4.1, with no known security issues.

Use it for:

• Expose Django event models as iCalendar feeds so users can subscribe in calendar applications.
• Build a to-do list application that generates iCal feeds for task management tools.
• Create recurring event feeds with alarms, attendee lists, and location data for scheduling applications.
• Syndicate meeting or conference schedules as iCal feeds for easy import into attendee calendars.
• Generate calendar feeds with custom metadata (organizer, categories, geographic coordinates) for integration with third-party calendar systems.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates iCalendar (iCal) feeds from Django models using Django's syndication feed framework as a base, supporting events, to-do items, alarms, and recurrence rules.

Yes, with conditions. The package is stable, has no vulnerabilities, and low install friction. It is the right tool if you need to expose Django models as iCalendar feeds and are comfortable with dormant maintenance (last release 2023-06-12). If you require active bug fixes or rapid support for new Django/Python versions, verify compatibility with your target stack first. For straightforward calendar feed generation on a stable Django project, it is a solid choice.

Install

django-ical on PyPI

pip install django-ical

uv add django-ical

poetry add django-ical

Installing django-ical

Before you install

Low friction install with three straightforward dependencies (django, icalendar, django-recurrence). Maintenance is dormant—last release was 2023-06-12—but the package is marked Production/Stable and has no known vulnerabilities, suggesting it is mature and not actively breaking.

License in practice

MIT License (permissive) places no restrictions on use, modification, or distribution in commercial or private projects.

Quickstart

pip install django-ical

from django_ical.views import ICalFeed

class EventFeed(ICalFeed):
    title = "My Events"
    description = "Calendar feed"
    
    def items(self):
        return []
    
    def item_title(self, item):
        return item.name
    
    def item_start_datetime(self, item):
        return item.start

Requires Django to be installed and configured; the package extends Django's syndication framework, so basic Django project setup is a prerequisite.

Verify before relying

• Whether dormant maintenance status poses a risk for future Django or Python version incompatibilities.
• Whether django-recurrence is required for all use cases or only for recurring event support.
• Real-world performance characteristics with large event datasets or high feed request volumes.

Package facts

Evidence: django_ical-1.9.2-py3-none-any.whl

Keywords: ical, calendar, django, syndication, feed

Tags

More Python Modules packages