From f2e291f120d6e090b71f33b6a7c58fa300058693 Mon Sep 17 00:00:00 2001 From: Lukas Geiger Date: Tue, 26 Dec 2017 12:00:26 +0100 Subject: [PATCH] Improve readme and add keywords This adds links to the feature providers used by `pyls`. --- README.md | 25 ++++++++++++------------- package.json | 12 ++++++++++-- 2 files changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6601ddc9..2e499bf4 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,29 @@ [![Greenkeeper badge](https://badges.greenkeeper.io/lgeiger/ide-python.svg)](https://greenkeeper.io/) -Python language support for Atom-IDE, powered by the [Python language server](https://github.com/palantir/python-language-server). +Python language support for [Atom-IDE](https://ide.atom.io/), powered by the [Python language server](https://github.com/palantir/python-language-server). ![ide-python](https://user-images.githubusercontent.com/13285808/30352538-b9687a76-9820-11e7-8876-c22751645d36.png) -## Early access -This package is currently an early access release. You should also install the [atom-ide-ui](https://atom.io/packages/atom-ide-ui) package to expose the functionality within Atom. +## Requirements +[`ide-python`](https://atom.io/packages/ide-python) requires [Atom `1.21+`](https://atom.io/) and the [`atom-ide-ui`](https://atom.io/packages/atom-ide-ui) package to expose the functionality within Atom. -## Features - -* Auto completion -* Code format -* Diagnostics (errors & warnings) -* Document outline -* Find references -* Hover +## Feature Providers +* [Jedi](https://github.com/davidhalter/jedi) for Completions, Definitions, Hover, References, Signature Help, and Symbols +* [Rope](https://github.com/python-rope/rope) for Completions and renaming +* [Pyflakes](https://github.com/PyCQA/pyflakes) linter to detect various errors +* [McCabe](https://github.com/PyCQA/mccabe) linter for complexity checking +* [pycodestyle](https://github.com/PyCQA/pycodestyle) linter for style checking +* [pydocstyle](https://github.com/PyCQA/pydocstyle) linter for docstring style checking +* [YAPF](https://github.com/google/yapf) for code formatting ## Installation - Install the language server with ```bash pip install python-language-server ``` -Verify that everything is correctly installed by running `pyls --help` from the command line. +Verify that everything is correctly installed and `pyls` is on your `PATH` by running `pyls --help` from the command line. It should return ```bash usage: pyls [-h] [--tcp] [--host HOST] [--port PORT] diff --git a/package.json b/package.json index 12792666..56a94ce5 100644 --- a/package.json +++ b/package.json @@ -4,12 +4,20 @@ "version": "0.3.0", "description": "Python language support for Atom-IDE", "keywords": [ - "atom-ide", "ide", "python", + "atom-ide", "languageserver", "language-server-protocol", - "language-client" + "language-client", + "autocomplete", + "jedi", + "rope", + "pyflakes", + "pycodestyle", + "pydocstyle", + "yapf", + "mccabe" ], "repository": "https://github.com/lgeiger/ide-python", "license": "MIT",