vContent

Annotated README.txt

61:43aded34a75f
2015-02-28 Paul Boddie Added docstrings.
paul@15 1
Introduction
paul@15 2
------------
paul@15 3
paul@15 4
The vContent distribution provides support for the parsing of the general file
paul@15 5
format described in RFCs 2445, 2425 and 2426, together with support for the
paul@15 6
more specialised iCalendar and vCalendar formats through the vCalendar module
paul@15 7
which applies certain data representation conversions. The vCard format is
paul@15 8
also supported, but merely through the general vContent module.
paul@15 9
paul@15 10
Using the Modules
paul@15 11
-----------------
paul@15 12
paul@15 13
The tests directory contains a number of demonstrations of parsing using the
paul@15 14
modules:
paul@15 15
paul@15 16
  test_calendar.py          A straightforward test of vCalendar parsing
paul@15 17
  test_calendar_stream.py   A round-trip test of stream parsing and output
paul@15 18
  test_card.py              A straightforward test of vCard parsing
paul@15 19
  test_card_stream.py       A round-trip test of stream parsing and output
paul@15 20
paul@15 21
Contact, Copyright and Licence Information
paul@15 22
------------------------------------------
paul@15 23
paul@15 24
The author can be contacted at the following e-mail address:
paul@15 25
paul@15 26
paul@boddie.org.uk
paul@15 27
paul@15 28
Copyright and licence information can be found in the docs directory - see
paul@15 29
docs/COPYING.txt and docs/gpl-3.0.txt for more information.
paul@21 30
paul@32 31
New in vContent 0.2.1 (Changes since vContent 0.2)
paul@32 32
--------------------------------------------------
paul@32 33
paul@32 34
  * Fixed infinite loop caused by carriage return at end of input.
paul@32 35
paul@21 36
New in vContent 0.2 (Changes since vContent 0.1)
paul@21 37
------------------------------------------------
paul@21 38
paul@21 39
  * Added support for writing resources through a specific write method
paul@21 40
    instead of using a stream, thus changing the iterwrite function's
paul@21 41
    signature.
paul@24 42
  * Added support for multiple property values, producing lists for
paul@24 43
    collections of such values when parsing, and accepting lists of such
paul@25 44
    values when writing. Tuples of values are also handled where such values
paul@25 45
    are separated by semicolons.