diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b65f794 --- /dev/null +++ b/README.rst @@ -0,0 +1,62 @@ +################################################################### +parso - A Python Parser Written in Python +################################################################### + +.. image:: https://secure.travis-ci.org/davidhalter/parso.png?branch=master + :target: http://travis-ci.org/davidhalter/parso + :alt: Travis-CI build status + +.. image:: https://coveralls.io/repos/davidhalter/parso/badge.png?branch=master + :target: https://coveralls.io/r/davidhalter/parso + :alt: Coverage Status + + +Parso is a Python parser that supports error recovery and round-trip parsing. + +Parso has been battle-tested by jedi_. It was pulled out of jedi to be useful +for other projects as well. + +Parso is very simplistic. It consists of a small API to parse Python and +analyse the parsing tree. + + +Ressources +========== + +- `PyPI `_ +- `Docs `_ +- Uses `semantic versioning `_ + +Installation +============ + + pip install parso + + +Testing +======= + +The test suite depends on ``tox`` and ``pytest``:: + + pip install tox pytest + +To run the tests for all supported Python versions:: + + tox + +If you want to test only a specific Python version (e.g. Python 2.7), it's as +easy as :: + + tox -e py27 + +Tests are also run automatically on `Travis CI +`_. + +Acknowledgements +================ + +- Guido van Rossum (@gvanrossum) for creating the parser generator pgen2 + (originally used in lib2to3). + + +.. _jedi: https://github.com/davidhalter/jedi