Skip to content

Commit 5920b9d

Browse files
committed
Improve readme and add keywords
This adds links to the feature providers used by `pyls`.
1 parent 3d12439 commit 5920b9d

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,29 @@
22

33
[![Greenkeeper badge](https://badges.greenkeeper.io/lgeiger/ide-python.svg)](https://greenkeeper.io/)
44

5-
Python language support for Atom-IDE, powered by the [Python language server](https://github.com/palantir/python-language-server).
5+
Python language support for [Atom-IDE](https://ide.atom.io/), powered by the [Python language server](https://github.com/palantir/python-language-server).
66

77
![ide-python](https://user-images.githubusercontent.com/13285808/30352538-b9687a76-9820-11e7-8876-c22751645d36.png)
88

9-
## Early access
10-
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.
9+
## Requirements
10+
[`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.
1111

12-
## Features
13-
14-
* Auto completion
15-
* Code format
16-
* Diagnostics (errors & warnings)
17-
* Document outline
18-
* Find references
19-
* Hover
12+
## Feature Providers
13+
* [Jedi](https://github.com/davidhalter/jedi) for Completions, Definitions, Hover, References, Signature Help, and Symbols
14+
* [Rope](https://github.com/python-rope/rope) for Completions and renaming
15+
* [Pyflakes](https://github.com/PyCQA/pyflakes) linter to detect various errors
16+
* [McCabe](https://github.com/PyCQA/mccabe) linter for complexity checking
17+
* [pycodestyle](https://github.com/PyCQA/pycodestyle) linter for style checking
18+
* [pydocstyle](https://github.com/PyCQA/pydocstyle) linter for docstring style checking
19+
* [YAPF](https://github.com/google/yapf) for code formatting
2020

2121
## Installation
22-
2322
Install the language server with
2423
```bash
2524
pip install python-language-server
2625
```
2726

28-
Verify that everything is correctly installed by running `pyls --help` from the command line.
27+
Verify that everything is correctly installed and `pyls` is on your `PATH` by running `pyls --help` from the command line.
2928
It should return
3029
```bash
3130
usage: pyls [-h] [--tcp] [--host HOST] [--port PORT]

package.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44
"version": "0.3.0",
55
"description": "Python language support for Atom-IDE",
66
"keywords": [
7-
"atom-ide",
87
"ide",
98
"python",
9+
"atom-ide",
1010
"languageserver",
1111
"language-server-protocol",
12-
"language-client"
12+
"language-client",
13+
"autocomplete",
14+
"jedi",
15+
"rope",
16+
"pyflakes",
17+
"pycodestyle",
18+
"pydocstyle",
19+
"yapf",
20+
"mccabe"
1321
],
1422
"repository": "https://github.com/lgeiger/ide-python",
1523
"license": "MIT",

0 commit comments

Comments
 (0)