diff options
| author | Claudiu Popa <pcmanticore@gmail.com> | 2015-12-10 15:55:50 +0200 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2015-12-10 15:55:50 +0200 |
| commit | 1a56244c5a8ead486c9cb36f577f9295233f242a (patch) | |
| tree | acb2dbae88087a87824c84c20f5230027b0946fe | |
| parent | 91747c50f885efe461c0054a7835992f49740ab9 (diff) | |
| download | astroid-1a56244c5a8ead486c9cb36f577f9295233f242a.tar.gz | |
| -rw-r--r-- | README | 69 |
1 files changed, 5 insertions, 64 deletions
@@ -1,64 +1,5 @@ -.. image:: https://drone.io/bitbucket.org/logilab/astroid/status.png - :alt: drone.io Build Status - :target: https://drone.io/bitbucket.org/logilab/astroid - -Astroid -======= - -What's this? ------------- - -The aim of this module is to provide a common base representation of -python source code for projects such as pychecker, pyreverse, -pylint... Well, actually the development of this library is essentially -governed by pylint's needs. It used to be called logilab-astng. - -It provides a compatible representation which comes from the `_ast` -module. It rebuilds the tree generated by the builtin _ast module by -recursively walking down the AST and building an extended ast. The new -node classes have additional methods and attributes for different -usages. They include some support for static inference and local name -scopes. Furthermore, astroid builds partial trees by inspecting living -objects. - -Main modules are: - -* `bases`, `node_classses` and `scoped_nodes` contain the classes for the - different type of nodes of the tree. - -* the `manager` contains a high level object to get astroid trees from - source files and living objects. It maintains a cache of previously - constructed tree for quick access. - - -Installation ------------- - -Extract the tarball, jump into the created directory and run:: - - python setup.py install - -For installation options, see:: - - python setup.py install --help - - -If you have any questions, please mail the code-quality@python.org -mailing list for support. See -http://mail.python.org/mailman/listinfo/code-quality for subscription -information and archives. You may find older archives at -http://lists.logilab.org/mailman/listinfo/python-projects . - -Python Versions ---------------- - -astroid is compatible with Python 2.7 as well as 3.3 and later. astroid uses -the same code base for both Python versions, using six. - -Test ----- - -Tests are in the 'test' subdirectory. To launch the whole tests suite -at once, you can use unittest discover:: - - python -m unittest discover -p "unittest*.py" +
+
+The official astroid repository has been moved to GitHub:
+
+https://github.com/pycqa/astroid
\ No newline at end of file |