Skip to content

Commit

Permalink
Add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gatesn committed Jan 4, 2017
1 parent ffa4b78 commit db3907f
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Python Language Server
======================

A Python 2.7 implementation of the `Language Server Protocol`_ making use of Jedi_, pycodestyle_, Pyflakes_ and YAPF_.

Features
--------

Auto Completion:

.. image:: resources/auto-complete.gif

Code Linting with pycodestyle and pyflakes:

.. image:: resources/linting.gif

Signature Help:

.. image:: resources/signature-help.gif

Go to definition:

.. image:: resources/goto-definition.gif

Hover:

.. image:: resources/hover.gif

Find References:

.. image:: resources/references.gif

Document Symbols:

.. image:: resources/document-symbols.gif

Document Formatting:

.. image:: resources/document-format.gif

Installation
------------

``pip install --process-dependency-links .``

Development
-----------

To run the test suite:

``pip install --process-dependency-links .[test] && tox``

License
-------

This project is made available under the MIT License.

.. _Language Server Protocol: https://github.com/Microsoft/language-server-protocol
.. _Jedi: https://github.com/davidhalter/jedi
.. _pycodestyle: https://github.com/PyCQA/pycodestyle
.. _Pyflakes: https://github.com/PyCQA/pyflakes
.. _YAPF: https://github.com/google/yapf

0 comments on commit db3907f

Please sign in to comment.