root/livinglogic.python.xist/README.rst @ 3740:728b18ab8897

Revision 3740:728b18ab8897, 3.6 KB (checked in by Walter Doerwald <walter@…>, 10 years ago)

Update description.

Line 
1Purpose
2-------
3
4XIST provides an extensible HTML and XML generator. XIST is also a XML parser
5with a very simple and pythonesque tree API. Every XML element type corresponds
6to a Python class and these Python classes provide a conversion method to
7transform the XML tree (e.g. into HTML). XIST can be considered
8'object oriented XSLT'.
9
10XIST also includes the following modules and packages:
11
12*   :mod:`ll.make` is an object oriented make replacement. Like make it allows
13    you to specify dependencies between files and actions to be executed
14    when files don't exist or are out of date with respect to one
15    of their sources. But unlike make you can do this in a object oriented
16    way and targets are not only limited to files, but you can implement
17    e.g. dependencies on database records.
18
19*   :mod:`ll.url` provides classes for parsing and constructing RFC 2396
20    compliant URLs.
21
22*   :mod:`ll.orasql` provides utilities for working with cx_Oracle_:
23
24    -   It allows calling functions and procedures with keyword arguments.
25
26    -   Query results will be put into Record objects, where database fields
27        are accessible as object attributes.
28
29    -   The :class:`Connection` class provides methods for iterating through the
30        database metadata.
31
32    -   Importing the module adds support for URLs with the scheme ``oracle`` to
33        :mod:`ll.url`.
34
35    .. _cx_Oracle: http://cx-oracle.sourceforge.net/
36
37*   :mod:`ll.ul4c` is compiler for a templating language with similar capabilities
38    to `Django's templating language`__. ``UL4`` templates are compiled to an
39    internal bytecode format, which makes it possible to implement template
40    renderers in other languages and makes the template code "secure" (i.e.
41    template code can't open or delete files).
42
43    __ http://www.djangoproject.com/documentation/templates/
44
45*   :mod:`ll.astyle` can be used for colored terminal output (via ANSI escape
46    sequences).
47
48*   :mod:`ll.color` provides classes and functions for handling RGB color values.
49    This includes the ability to convert between different color models
50    (RGB, HSV, HLS) as well as to and from CSS format, and several functions
51    for modifying and mixing colors.
52
53*   :mod:`ll.misc` provides several small utility functions and classes.
54
55*   :mod:`ll.sisyphus` provides classes for running Python scripts as cron jobs.
56
57*   :mod:`ll.daemon` can be used on UNIX to fork a daemon process.
58
59*   :mod:`ll.xml_codec` contains a complete codec for encoding and decoding XML.
60
61
62Documentation
63-------------
64
65For documentation read the files in the ``docs/`` directory or the
66`web pages`__.
67
68__ http://www.livinglogic.de/Python/xist/
69
70For installation instructions read ``INSTALL.rst`` or the
71`installation web page`__.
72
73__ http://www.livinglogic.de/Python/xist/Installation.html
74
75For a history of XIST and a list of new features in this version,
76read ``NEWS.rst`` or the `history web page`__.
77
78__ http://www.livinglogic.de/Python/xist/History.html
79
80For a list of old features and bugfixes read ``OLDNEWS`` or the
81`old history web page`__.
82
83__ http://www.livinglogic.de/Python/xist/OldHistory.html
84
85For the license read ``__init__.py``.
86
87
88Download
89--------
90
91XIST is available via ftp_, http_ or from the cheeseshop_.
92
93.. _ftp: ftp://ftp.livinglogic.de/pub/livinglogic/xist/
94.. _http: http://ftp.livinglogic.de/xist/
95.. _cheeseshop: http://cheeseshop.python.org/pypi/ll-xist
96
97
98Mailing lists
99-------------
100
101A discussion mailing list is available. For more info go to
102https://mail.livinglogic.de/mailman/listinfo/xist-discuss. You can subscribe
103from these webpages as well as read the mailing list archives.
104
105An announcement mailing list is available too. For info go to
106https://mail.livinglogic.de/mailman/listinfo/xist-announce
107
108
109-- Walter Dörwald <walter@livinglogic.de>
Note: See TracBrowser for help on using the browser.