summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSylvain Th?nault <sylvain.thenault@logilab.fr>2009-08-26 07:56:18 +0200
committerSylvain Th?nault <sylvain.thenault@logilab.fr>2009-08-26 07:56:18 +0200
commit298b79f04cf9ebfe337759085fcf5c829bfa7780 (patch)
tree04e4981a3a226e3862f767a3c8c1e3255a665f7d /README
parent099b27d3cf2909b8d401f2100cb5c352a47db4d8 (diff)
downloadastroid-298b79f04cf9ebfe337759085fcf5c829bfa7780.tar.gz
update README
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 17 insertions, 20 deletions
diff --git a/README b/README
index a771b0a..1e38481 100644
--- a/README
+++ b/README
@@ -9,30 +9,26 @@ python source code for projects such as pychecker, pyreverse,
pylint... Well, actually the development of this library is essentialy
governed by pylint's needs.
-It extends class defined in the compiler.ast [1] module with some
-additional methods and attributes. Instance attributes are added by a
-builder object, which can either generate extended ast (let's call
-them astng ;) by visiting an existant ast tree or by inspecting living
-object. Methods are added by monkey patching ast classes.
+Since 0.18, it provides a compatible representation which may come
+from the `compiler` module (for python <= 2.4) pr the `_ast` module
+(for python >= 2.5).
+
+It extends bare node classes with some additional methods and
+attributes. Instance attributes are added by a builder object, which
+can generate extended ast (let's call them astng ;) by visiting either
+an existant ast tree or by inspecting living object. Methods are added
+by monkey patching ast classes. Finally some support for static
+inference is provided.
Main modules are:
-* nodes and scoped_nodes for more information about methods and
+* `nodes` and `scoped_nodes` for more information about methods and
attributes added to different node classes
-* the manager contains a high level object to get astng trees from
+* the `manager` contains a high level object to get astng trees from
source files and living objects. It maintains a cache of previously
constructed tree for quick access
-* builder contains the class responsible to build astng trees
-
-
-Notice
-------
-This package has been extracted from the logilab-common package, which
-will be kept for some time for backward compatibility but will no
-longer be maintained.
-
Installation
------------
@@ -46,9 +42,10 @@ For installation options, see ::
python setup.py install --help
-If you have any questions, please mail the python-project@logilab.org mailing
-list for support (http://lists.logilab.org/mailman/listinfo/python-projects
-for subscription information)
+If you have any questions, please mail the
+python-project@lists.logilab.org mailing list for support. See
+http://lists.logilab.org/mailman/listinfo/python-projects for
+subscription information and archives.
Sylvain Thénault
-Oct 21, 2005
+Oct 21, 2005, updated on Aug 26 2009.