claytonsulby / iCalendarParser

iCalendar (RFC5545) parser in Swift

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

iCalendarParser

A RFC 5545 compatible parser for iCalendar files in Swift.

Installation

To use iCalendarParser just add it as Swift Package Manager dependency:

via Xcode

Open your project, click on File → Add Packages, enter the repository URL (https://github.com/dmail-me/iCalendarParser.git), and add the package product to your app target.

via SPM Package.swift

dependencies: [
    .package(
      name: "iCalendarParser",
      url: "https://github.com/dmail-me/iCalendarParser",
      from: "0.1.0"
    )
]

Usage

To get started with iCalendarParser, all you have to do is to import it and use its ICParser type to convert any ICS file into iCalendar object:

import iCalendarParser

let rawICS: String = ...
let parser = ICParser()
let calendar: ICalendar? = parser.calendar(from: rawICS)

Is it production ready?

iCalendarParser is currently not feature complete yet. While it requires an additional implementation to be fully compatible with RFC5545, we appreciate contributions from the community to help us improve the library.

However, it's worth noting that the library is being used in production within the Dmail.me app, and we are committed to constantly improving it.

TODO

  • Parse To-Do, Journal, Free/Busy, and Alarm components
  • Add additional properties in ICEvent

Contributing

Contributions to iCalendarParser are welcomed and encouraged!

License

iCalendarParser is available under the MIT license. See LICENSE for more information.

Credits

About

iCalendar (RFC5545) parser in Swift

License:MIT License


Languages

Language:Swift 99.8%Language:Makefile 0.2%