arran4 / golang-ical

A ICS / ICal parser and serialiser for Golang.
Apache License 2.0
297 stars 73 forks source link

please show more examples on usage #51

Open emdete opened 2 years ago

emdete commented 2 years ago

Please add some code examples on how to use the structure after parsing to retrieve the usual information. i am not an ical expert and couldnt find out how to get the data from a parsed ical (my start time is zero for all values ;) )

arran4 commented 2 years ago

I've been thinking the same thing. I originally wrote this internally for a booking and planning system it was bare minimum and very much dependent on knowledge. I was meaning to add higher level utility functions too for your use case.

emdete commented 2 years ago

just some sample code (more tests would be a help too) would do, i see alot of editing ical after reading/parsing but no simple parse, get summary and description, get start and endtime, get organizer and attendee, ... that would be sufficient for me.

i admit i am not an ical, ics, vobject, .. expert, in fact i dont like that format ;) and maybe its just some lazyness here that i ask for code samples for cut&paste programming? ;)

arran4 commented 2 years ago

I think part of the problem is that this is such a low level library. I always intended to produce a "util" project which uses this. However circumstances haven't aligned with that.

Eitherway I will keep this open for when it fits.

emdete commented 2 years ago

can you give some sample code how to extract the most important fields?

arran4 commented 2 years ago

Hi @emdete , I will get around to fulfilling this ticket. However I am working on something else right now. I don't have any examples, so I would have to make them up from scratch. (I am not an active user of the library.)

The library is just a basic parsing library for https://www.ietf.org/rfc/rfc2445.txt so in the mean time some examples there might help. I do plan a major documentation update to the project.

In the mean time is there anything else I could do to help you get around what is currently blocking you on your project?