diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 24 insertions, 23 deletions
@@ -10,14 +10,6 @@ Support \#calendar-cli at irc.freenode.org, eventually t-calendar-cli@tobixen.no, eventually the issue tracker at https://github.com/tobixen/calendar-cli/issues -Status ------- - -This is work in progress. Writing to calendars seems to work, and I'm using it actively for adding stuff to my calendars - taking out the agenda is also possible, but could need more work. - -This is written in python2 as some of the libraries being used aren't -available in python3. - Rationale --------- @@ -63,24 +55,26 @@ not be up-to-date and may contain features not implemented yet. ### Event time specification -Supported in v0.06: +Supported in v0.9: * anything recognized by dateutil.parser.parse() +* An iso time stamp, followed with the duration, using either + or space as separator. Duration is a number postfixed by s for seconds, m for minutes, h for hours, d for days, w for weeks and y for years (i.e. 2013-09-10T13:37+30d) All of those would eventually be supported in future versions if it's not too difficult to achieve: -* An iso time stamp, followed with the duration, using either + or space as separator. Duration is a number postfixed by s for seconds, m for minutes, h for hours, d for days, w for weeks and y for years (i.e. 2013-09-10T13:37+30d) * Two ISO timestamps separated by a dash (-) * ISO dates without times (default duration will be one day, for two dates full days up to and including the end date is counted) * "tomorrow" instead of an ISO date * weekday instead of an ISO date * clock time without the date; event will be assumed to start within 24 hours. -Alternatively, endtime or duration can be given through options (not supported as of 0.06. All events are considered to be one hour long). +Alternatively, endtime or duration can be given through options (not supported as of 0.9) Configuration file ------------------ +Configuration file is by default located in $HOME/.config/calendar.conf and should be in json syntax. As of version 0.8 you may run `calendar-cli --interactive-config` if you don't feel comfortable with hand-crafting configuration in json syntax. + (I considered a configuration file in .ini-format, having a "default"-section with default values for any global options, and optionally other sections for different CalDAV-servers. Asking a bit around for recommendations on config file format as well as location, I was told that the .ini-format is not a standard, I'd be better off using a standard like yaml, json or xml. Personally I like json a bit better than yaml - after consulting with a friend I ended up with json. Location ... I think it's "cleaner" to keep it in ~/.config/, and I'd like any calendar application to be able to access the file, hence it got ~/.config/calendar.conf rather than ~/.calendar-cli.conf) The file may look like this: @@ -114,22 +108,29 @@ Objectives * It should be possible to get out lists ("agenda") of calendar items and todo-items. * Interface for copying calendar items between calendars, even between calendars on distinct caldav servers -Status ------- +Changelog +--------- -2013-09-15: Made a repository at github and wrote up this README. -2013-09-24: version 0.01 - supports creating an ical-file based on command line parameters -2013-09-28: version 0.02 - possible to add a calendar item to the caldav server -2013-10-02: version 0.03 - support for configuration file -2013-10-05: version 0.04 - no need to specify URL for the default calendar -2013-12 - 2014-03: helped cyrilrbt on making a new release of the caldav library -2014-03-07: version 0.05 - rewrote parts of the tool to using the caldav library. Nice!!! -2014-03-14: version 0.6 - now agenda works quite smooth. I think this is becoming a useful tool. -2015-02-15: version 0.7 - supports deletion of events, alternative templates for the event output and a small testing script +* 2013-09-15: Made a repository at github and wrote up this README. +* 2013-09-24: version 0.01 - supports creating an ical-file based on command line parameters +* 2013-09-28: version 0.02 - possible to add a calendar item to the caldav server +* 2013-10-02: version 0.03 - support for configuration file +* 2013-10-05: version 0.04 - no need to specify URL for the default calendar +* 2013-12 - 2014-03: helped cyrilrbt on making a new release of the caldav library +* 2014-03-07: version 0.05 - rewrote parts of the tool to using the caldav library. Nice!!! +* 2014-03-14: version 0.6 - now agenda works quite smooth. I think this is becoming a useful tool. +* 2015-02-15: version 0.7 - supports deletion of events, alternative templates for the event output and a small testing script +* 2015-03-30: version 0.8 - has a interactive configuration mode for those not feeling comfortable with hand-crafting the config in json syntax +* 2015-03-30: version 0.9 - now it's possible to set a duration when adding events to the calendar. Roadmap ------- -* Allow specification of event duration when adding events to calendar +* Allow pulling out an agenda for all calendars at once (though, with the current design it's so much easier to do it through a bash loop rather than in the python code, so this is postponed for a while) +* Allow specification of event duration and/or event end time through options * CLI-interface for creating ical todo events * Fix easy-to-use symlinks (or alternatively wrapper scripts) * Make some nosetests + +Donations +--------- +Donations are not expected, but as long as this is a one-man hobby project at least it's not problematic to receive donations. Send bitcoins to 139xWFKwX9WejtRR1HP917qJGnRkZ6kn4M eventually. Donations may motivate me to work on specific feature requests or issues. |