# HG changeset patch # User Paul Boddie # Date 1310941377 -7200 # Node ID 7668ad359843573c11279e0830b929f053f7337a # Parent aaeb2407797f57f289cdd497523ea3528c9851cf Added documentation and packaging-related files. Added some docstrings to the tests. diff -r aaeb2407797f -r 7668ad359843 PKG-INFO --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PKG-INFO Mon Jul 18 00:22:57 2011 +0200 @@ -0,0 +1,19 @@ +Metadata-Version: 1.1 +Name: vContent +Version: 0.1 +Author: Paul Boddie +Author-email: paul at boddie org uk +Maintainer: Paul Boddie +Maintainer-email: paul at boddie org uk +Summary: Parsing and serialisation of iCalendar/vCalendar-style data +License: GPL (version 3 or later) +Description: The vContent distribution provides support for the parsing of the general file + format described in RFCs 2445, 2425 and 2426, together with support for the + more specialised iCalendar and vCalendar formats through the vCalendar module + which applies certain data representation conversions. The vCard format is + also supported, but merely through the general vContent module. +Keywords: iCalendar vCalendar vCard +Classifier: Development Status :: 3 - Alpha +Classifier: License :: OSI Approved :: GNU General Public License (GPL) +Classifier: Programming Language :: Python +Classifier: Topic :: Internet :: WWW/HTTP diff -r aaeb2407797f -r 7668ad359843 README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Mon Jul 18 00:22:57 2011 +0200 @@ -0,0 +1,29 @@ +Introduction +------------ + +The vContent distribution provides support for the parsing of the general file +format described in RFCs 2445, 2425 and 2426, together with support for the +more specialised iCalendar and vCalendar formats through the vCalendar module +which applies certain data representation conversions. The vCard format is +also supported, but merely through the general vContent module. + +Using the Modules +----------------- + +The tests directory contains a number of demonstrations of parsing using the +modules: + + test_calendar.py A straightforward test of vCalendar parsing + test_calendar_stream.py A round-trip test of stream parsing and output + test_card.py A straightforward test of vCard parsing + test_card_stream.py A round-trip test of stream parsing and output + +Contact, Copyright and Licence Information +------------------------------------------ + +The author can be contacted at the following e-mail address: + +paul@boddie.org.uk + +Copyright and licence information can be found in the docs directory - see +docs/COPYING.txt and docs/gpl-3.0.txt for more information. diff -r aaeb2407797f -r 7668ad359843 setup.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.py Mon Jul 18 00:22:57 2011 +0200 @@ -0,0 +1,12 @@ +#! /usr/bin/env python + +from distutils.core import setup + +setup( + name = "vContent", + description = "Parsing and serialisation of iCalendar/vCalendar-style data", + author = "Paul Boddie", + author_email = "paul@boddie.org.uk", + version = "0.1", + py_modules = ["vContent", "vCalendar"] + ) diff -r aaeb2407797f -r 7668ad359843 tests/test_calendar_stream.py --- a/tests/test_calendar_stream.py Sun Jul 17 22:29:13 2011 +0200 +++ b/tests/test_calendar_stream.py Mon Jul 18 00:22:57 2011 +0200 @@ -1,5 +1,10 @@ #!/usr/bin/env python +""" +Perform a round trip with an input calendar, comparing the result to the +original. +""" + import codecs, vCalendar, os this_dir = os.path.split(__file__)[0] diff -r aaeb2407797f -r 7668ad359843 tests/test_card_stream.py --- a/tests/test_card_stream.py Sun Jul 17 22:29:13 2011 +0200 +++ b/tests/test_card_stream.py Mon Jul 18 00:22:57 2011 +0200 @@ -1,5 +1,7 @@ #!/usr/bin/env python +"Perform a round trip with an input card, comparing the result to the original." + import codecs, vContent, os this_dir = os.path.split(__file__)[0]