[Checkins] SVN: classix/trunk/s Release preparations.
Martijn Faassen
faassen at infrae.com
Mon Jul 7 16:59:11 EDT 2008
Log message for revision 88086:
Release preparations.
Changed:
U classix/trunk/setup.py
U classix/trunk/src/classix/README.txt
-=-
Modified: classix/trunk/setup.py
===================================================================
--- classix/trunk/setup.py 2008-07-07 17:06:04 UTC (rev 88085)
+++ classix/trunk/setup.py 2008-07-07 20:59:08 UTC (rev 88086)
@@ -1,5 +1,19 @@
+import os
+
from setuptools import setup, find_packages
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+long_description = (
+ read('src', 'classix', 'README.txt')
+ + '\n' +
+ read('CHANGES.txt')
+ + '\n' +
+ 'Download\n'
+ '********\n'
+ )
+
setup(
name='classix',
version='0.1',
@@ -8,8 +22,10 @@
description="""\
Declarative way to associate classes with lxml XML elements.
""",
+ long_description=long_description,
packages=find_packages('src'),
package_dir = {'': 'src'},
+ license='ZPL 2.1',
include_package_data = True,
zip_safe=False,
install_requires=[
Modified: classix/trunk/src/classix/README.txt
===================================================================
--- classix/trunk/src/classix/README.txt 2008-07-07 17:06:04 UTC (rev 88085)
+++ classix/trunk/src/classix/README.txt 2008-07-07 20:59:08 UTC (rev 88086)
@@ -1,6 +1,9 @@
Classix
-=======
+*******
+Introduction
+============
+
Classix is a thin layer over lxml's `custom element classes`_
functionality that lets you configure them declaratively. It uses
Martian_ to accomplish this effect, but to you this should be an
@@ -15,6 +18,9 @@
right elements in the XML document after parsing. This way you can
enrich the content model of your XML document.
+The approach
+============
+
First we need to do the configuration for this package. This only needs to
happen once for this package. First, we need to set up a ``GrokkerRegistry``.
@@ -70,7 +76,7 @@
'The custom method'
No namespace
-------------
+============
Sometimes you want to associate a class with an element in no
namespace at all. Do do this, you can set the namepace to None
@@ -130,7 +136,7 @@
'The custom method for no namespace 2'
Namespaces in parser
---------------------
+====================
As a convenience, you can also configure the default namespace in the
parser, as a fall-back so you don't have to specify it in all the
@@ -157,13 +163,3 @@
>>> root = etree.XML(xml, parser_ns)
>>> root.custom_method()
'Another custom method'
-
-Absent classix.parser directive
--------------------------------
-
-If the ``classix.parser` directive is absent, ``classix.Element``
-subclasses will be automatically associated with the one
-``classix.Parser`` available in the module...
-
-XXX TODO
-
More information about the Checkins
mailing list