summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTobias Brox <tobixen@gmail.com>2014-03-10 20:23:47 +0100
committerTobias Brox <tobixen@gmail.com>2014-03-10 20:23:47 +0100
commitc81d99fb5b2c59f07894817953ac4b9f43d75c7b (patch)
treeb58564173928f48090a341f1836c1f9fd7fde4d6 /README.md
parent06fd72260d003c9c01c98eccfeb0dbc6e8b87872 (diff)
parent73527e4fc4cd399657522914ce7d26b6a690cbec (diff)
downloadcalendar-cli-c81d99fb5b2c59f07894817953ac4b9f43d75c7b.zip
got agenda to work
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 46 insertions, 6 deletions
diff --git a/README.md b/README.md
index 63bd746..5f16d67 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,19 @@ calendar-cli
Simple command-line CalDav client, for adding and browsing calendar items, todo list items, etc
+Support
+-------
+
+#calendar-cli at irc.freenode.org
+
+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 not completed yet.
+
+This is written in python2 as some of the libraries being used aren't
+available in python3.
+
Rationale
---------
@@ -18,7 +31,7 @@ Synopsis
calendar-cli.py [global options] [command] [command options] [subcommand] [subcommand options] [subcommand arguments] ...
-cli.py should be symlinked to the various commands.
+I'm intending to make it easier by allowing calendar-cli.py to be symlinked to the various commands.
### Global options
@@ -30,22 +43,25 @@ Always consult --help for up-to-date and complete listings of options.
The list below will only contain the most important options and may
not be up-to-date and may contain features not implemented yet.
-* --interactive, -i: stop and query the user rather often
+* --interactive: stop and query the user rather often
* --caldav-url, --caldav-user, --caldav-pass: how to connect to the CalDAV server. Fits better into a configuration file.
* --config-file: use a specific configuration file (default: $HOME/.calendar-cli.conf)
* --config-section: use a specific section from the config file (i.e. to select a different caldav-server to connect to)
-* --icalendar: instead of connecting to a CalDAV server, write an icalendar file to stdout
+* --icalendar: Write or read icalendar to/from stdout/stdin
+* --nocaldav: don't connect to a caldav server
### Commands
* cal - access/modify a calendar
- * subcommands: add, agenda
+ * subcommands: add, addics (for uploading events in ical format), agenda
* todo - access/modify a todo-list
* subcommands: add, agenda
+(only "cal add" and "cal addics" works as of v0.06 / 2013-12-02)
+
### Event time specification
-Supported in v0.01:
+Supported in v0.06:
* anything recognized by dateutil.parser.parse()
@@ -58,7 +74,7 @@ All of those would eventually be supported in future versions if it's not too di
* 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.
+Alternatively, endtime or duration can be given through options (not supported as of 0.06. All events are considered to be one hour long).
Configuration file
------------------
@@ -96,6 +112,7 @@ 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
+<<<<<<< HEAD
Milestones
----------
@@ -119,3 +136,26 @@ Status
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!!!
+=======
+Roadmap
+-------
+* Allow specification of event duration when adding events to calendar
+* Show agenda. Hope to have this in place during January 2014. (I've obeen hitting a snag in the underlying library, and will probably have to replace it).
+* Delete events. Needed for making a functional test suite.
+* Fix a functional test suite.
+* CLI-interface for creating ical todo events
+* Wrap it into an easy-to-install package
+* Fix easy-to-use symlinks
+
+History
+-------
+
+* 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-10-10: Attempts on implementing "agenda" stalled a bit due to problems with the library used. Considering to switch library.
+* 2013-11-30: version 0.05 - added the calendar "addics" command for adding an ics file
+* 2013-12-02: Some merging of work between the "agenda" branch and the master branch; causing a minor API change (new option --nocaldav has to be specified if running the utility without connecting to a caldav server)
+>>>>>>> master