Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pat/livecal
Translate ical/ics files into actual calendars and events
https://github.com/pat/livecal
Last synced: 17 days ago
JSON representation
Translate ical/ics files into actual calendars and events
- Host: GitHub
- URL: https://github.com/pat/livecal
- Owner: pat
- License: other
- Created: 2021-06-06T11:43:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T13:17:03.000Z (3 months ago)
- Last Synced: 2024-11-13T02:21:38.767Z (about 1 month ago)
- Language: Ruby
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Livecal
Livecal processes ical files and translates them into calendars with events listed as they're actually scheduled (i.e. recurring events are provided for each instance that they occur, not just the single piece of information that they're stored as in an ical file).
## Usage
```ruby
# You must provide from/to (otherwise endless recurring events will continue
# forever). The example here is the next 24 hours, but you can use whatever
# frame of time you like.
)
calendars = Livecal.from_string(
contents_of_an_ical_file,
from: Time.now,
to: (Time.now + 86_400)
)
calendars.each do |calendar|
calendar.events.each do |event|
puts event.summary, event.starts_at, event.ends_at
end
end
# Also:
calendars = Livecal.from_url(
"http://example.com/calendar.ics",
from: Time.now,
to: (Time.now + 86_400)
)
# And:
calendars = Livecal.from_file(
"/path/to/my-calendars.ics",
from: Time.now,
to: (Time.now + 86_400)
)
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem "livecal"
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install livecal
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/pat/livecal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pat/livecal/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [Hippocratic License](https://firstdonoharm.dev).
## Code of Conduct
Everyone interacting in the Livecal project is expected to follow the [code of conduct](https://github.com/pat/livecal/blob/master/CODE_OF_CONDUCT.md).