Skip to content

Commit 8617e76

Browse files
committed
Update installation instructions
1 parent 4c218be commit 8617e76

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Python language support for [Atom-IDE](https://ide.atom.io/), powered by the [Py
88

99
## Requirements
1010

11-
[`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.
11+
[`ide-python`](https://atom.io/packages/ide-python) requires [Atom `1.21+`](https://atom.io/), [Python language server 0.17+`](https://github.com/palantir/python-language-server) and the [`atom-ide-ui`](https://atom.io/packages/atom-ide-ui) package to expose the functionality within Atom.
1212

1313
## Feature Providers
1414

@@ -18,16 +18,21 @@ Python language support for [Atom-IDE](https://ide.atom.io/), powered by the [Py
1818
* [McCabe](https://github.com/PyCQA/mccabe) linter for complexity checking
1919
* [pycodestyle](https://github.com/PyCQA/pycodestyle) linter for style checking
2020
* [pydocstyle](https://github.com/PyCQA/pydocstyle) linter for docstring style checking
21+
* [autopep8](https://github.com/hhatto/autopep8) for code formatting (preferred over YAPF)
2122
* [YAPF](https://github.com/google/yapf) for code formatting
2223

2324
## Installation
2425

25-
Install the language server (we recommend version `0.14.0` or newer) with
26+
### Language Server
27+
28+
Install the language server (we recommend version 0.17.0 or newer) with:
2629

2730
```bash
28-
pip install python-language-server
31+
pip install 'python-language-server[all]'
2932
```
3033

34+
This command will install the language server and all supported feature providers, which can be enabled or disabled in the settings. Checkout the [official installation instructions](https://github.com/palantir/python-language-server#installation) on how to install only the providers you need.
35+
3136
Verify that everything is correctly installed and `pyls` is on your `PATH` by running `pyls --help` from the command line.
3237
It should return
3338

@@ -41,11 +46,20 @@ Python Language Server
4146

4247
Depending on your Python setup `pyls` may be installed in a non default folder. In this case either add the directory to your `PATH` or edit the "Python Language Server Path" setting of `ide-python` to point to the `pyls` executable.
4348

49+
### Atom Package
50+
51+
Install `ide-python` and [`atom-ide-ui`](https://atom.io/packages/atom-ide-ui) from _Install_ in Atom's settings or run:
52+
53+
```bash
54+
apm install atom-ide-ui
55+
apm install ide-python
56+
```
57+
4458
## Configuration
4559

4660
Configuration is loaded from zero or more configuration sources.
4761

48-
* `pycodestyle` (default): discovered in `~/.config/pycodestyle`, `setup.cfg`, `tox.ini` and `pycodestyle.cfg`
62+
* `pycodestyle`: discovered in `~/.config/pycodestyle`, `setup.cfg`, `tox.ini` and `pycodestyle.cfg`
4963
* `flake8`: discovered in `~/.config/flake8`, `setup.cfg`, `tox.ini` and `flake8.cfg`
5064

5165
Overall configuration is computed first from user configuration (in home directory), overridden by configuration in the `ide-python` settings, and then overridden by configuration discovered in the current project.

lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class PythonLanguageClient extends AutoLanguageClient {
6363
}
6464
],
6565
description:
66-
"This can occur if you do not have Python installed or if it is not in your path.\n\n Make sure to install `pyls` by running:\n```\npip install python-language-server\n```"
66+
"This can occur if you do not have Python installed or if it is not in your path.\n\n Make sure to install `pyls` by running:\n```\npip install 'python-language-server[all]'\n```"
6767
})
6868
);
6969
return childProcess;

0 commit comments

Comments
 (0)