cctool

commit

e95e5d7b116179fc96c45e687c80542d69b4c824

parent

715883b5de21a2c56a1b52915858fb67e96fc819

Author

Tobias Bengfort <tobias.bengfort@gmx.net>

Date

2015-05-08 18:53

add some documentation on person vs event

Diffstat

1 files changed, 11 insertions, 3 deletions

diff --git a/cctool.py b/cctool.py

@@ -20,10 +20,18 @@
   20    20 cctool can read entries from different source formats and output them to
   21    21 different target formats. For example, it could be used to combine birthday
   22    22 dates from an addressbook and a calendar.
   23    -1 """
   24    23 
   25    -1 # internal representation: iterable of dicts with unsepcified format.
   26    -1 # interpretation of different keys and values happens at dump
   -1    24 While each item is a generic MultiDict, there are typically two usecases:
   -1    25 
   -1    26 -	A *person* with the possible fields *'name', 'nick', 'bday', 'email',
   -1    27 	'address_lines', 'city', 'state', 'zip', 'country', 'phone', 'workphone',
   -1    28 	'mobile', 'xmpp', 'icq', 'msn', 'twitter', and 'pgp'.
   -1    29 
   -1    30 -	An *event* with the possible fields 'description', 'location', 'summary',
   -1    31 	'dtend', 'dtstart', and 'freq'.
   -1    32 
   -1    33 In addition, each item may have the generic fields 'tag', 'comment', and 'url'.
   -1    34 """
   27    35 
   28    36 from __future__ import print_function
   29    37