diff options
| author | Claudiu Popa <pcmanticore@gmail.com> | 2018-06-03 18:40:44 +0800 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2018-06-04 06:52:05 -0700 |
| commit | 563b42b62d648cdf8d9b081f0df6a22c80109ee7 (patch) | |
| tree | de67898ff1e57286ef8de73176bc58060bd2046a /README.rst | |
| parent | 2fcb7e6e4ea33ea8b38429f85f55d681a0cf1e35 (diff) | |
| download | astroid-git-563b42b62d648cdf8d9b081f0df6a22c80109ee7.tar.gz | |
Drop the references to Python 2 from the README and clean it up a bit
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 22 |
1 files changed, 10 insertions, 12 deletions
@@ -21,16 +21,14 @@ 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. +python source code. It is currently the powering pylint's capabilities. 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 +usages. They include some support for static inference and local name +scopes. Furthermore, astroid can also build partial trees by inspecting living objects. @@ -49,19 +47,19 @@ For installation options, see:: 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 . +information and archives. Python Versions --------------- -astroid is compatible with Python 2.7 as well as 3.4 and later. astroid uses -the same code base for both Python versions, using six. +astroid 2.0 is currently available for Python 3 only. If you want Python 2 +support, older versions of astroid will still supported until 2020. Test ---- -Tests are in the 'test' subdirectory. To launch the whole tests suite -at once, you can use unittest discover:: +Tests are in the 'test' subdirectory. To launch the whole tests suite, you can use +either `tox` or `pytest`:: - python -m unittest discover -p "unittest*.py" + tox + pytest astroid |