Skip to content

Improve readme and add keywords #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 26, 2017
Merged

Improve readme and add keywords #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
12 changes: 10 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down