mirror of
https://github.com/davidhalter/parso.git
synced 2025-12-06 12:54:29 +08:00
Add an initial README.rst.
This commit is contained in:
62
README.rst
Normal file
62
README.rst
Normal file
@@ -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 <https://pypi.python.org/pypi/parso>`_
|
||||||
|
- `Docs <https://parso.readthedocs.org/en/latest/>`_
|
||||||
|
- Uses `semantic versioning <http://semver.org/>`_
|
||||||
|
|
||||||
|
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
|
||||||
|
<https://travis-ci.org/davidhalter/parso/>`_.
|
||||||
|
|
||||||
|
Acknowledgements
|
||||||
|
================
|
||||||
|
|
||||||
|
- Guido van Rossum (@gvanrossum) for creating the parser generator pgen2
|
||||||
|
(originally used in lib2to3).
|
||||||
|
|
||||||
|
|
||||||
|
.. _jedi: https://github.com/davidhalter/jedi
|
||||||
Reference in New Issue
Block a user