Skip to content

Commit e82713a

Browse files
committed
Add readme
1 parent 339c672 commit e82713a

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# ide-python
1+
# IDE-python package
2+
3+
Python language support for Atom-IDE, powered by the [Python language server](https://github.com/palantir/python-language-server).
4+
5+
![ide-python](https://user-images.githubusercontent.com/13285808/30352538-b9687a76-9820-11e7-8876-c22751645d36.png)
6+
7+
## Early access
8+
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+
10+
## Features
11+
12+
* Auto completion
13+
* Code format
14+
* Diagnostics (errors & warnings)
15+
* Document outline
16+
* Find references
17+
* Hover
18+
19+
## Installation
20+
21+
Install the language server with
22+
```bash
23+
pip install python-language-server
24+
```
25+
26+
Verify that everything is correctly installed by running `pyls --help` from the command line.
27+
It should return
28+
```bash
29+
usage: pyls [-h] [--tcp] [--host HOST] [--port PORT]
30+
[--log-config LOG_CONFIG | --log-file LOG_FILE] [-v]
31+
32+
Python Language Server
33+
...
34+
```
35+
36+
## Contributing
37+
Always feel free to help out! Whether it's [filing bugs and feature requests](https://github.com/lgeiger/ide-python/issues/new) or working on some of the [open issues](https://github.com/lgeiger/ide-python/issues), Atom's [guide for contributing to packages](https://github.com/atom/atom/blob/master/docs/contributing-to-packages.md) will help get you started.
38+
39+
## License
40+
MIT License. See [the license](LICENSE.md) for more details.

0 commit comments

Comments
 (0)