Skip to content

Commit

Permalink
Add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
bazitur committed Nov 3, 2017
1 parent 1c20bc3 commit d6d0c9c
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
@@ -1,13 +1,28 @@
## brackets-python-tools: Easy Python development with Brackets
## brackets-python-tools: Python development with Brackets

A set of tools which will make Brackets your favourite backend IDE.

> *Please note that this project is still in alpha. Feel free to report an issue or add a pull request!*
### Features
- Smart autocompletion
- Go to definition/assignment
- Inline Python documentation
- Linter

### Some screenshots
![autocompletion](screenshots/autocompletion.png)
*Python Autocompletion*

![linting](screenshots/lint.png)
*Linting via Flake8*

![docs](screenshots/docs.png)
*Inline documentation*

![settings](screenshots/settings.png)
*Settings dialog*

### Installation
You can install Python Tools from official Brackets Extension Registry.
Additionally, you'll need:
Expand All @@ -28,17 +43,17 @@ This Extension uses Python 3 interpreter in your path by default. You can custom
Settings are accessible through standart brackets settings interface or 'File' menu 🡒 Python Tools Settings.

Currently available settings:
- `pathToPython`: String
- `pathToPython`: String<br>
Full path to python executable. Default value is `python3`.
- `isCaseSensitive`: Boolean
- `isCaseSensitive`: Boolean<br>
If code completion should be case sensitive. Default is `true`.
- `maxLineLength`: Number
- `maxLineLength`: Number<br>
Maximum line length in Python files. Default: `79`.
- `ignoredErrors`: Array
- `ignoredErrors`: Array<br>
Array of errors which should be ignored by Python Linter. Default: `[]`

### Credits
This project is based on the [Python Jedi Brackets](https://github.com/saravanan-k90/python-jedi-brackets) project.

### License
The source code is licensed MIT. See [LICENSE.md] for more.
The source code is licensed MIT. See [LICENSE.md](LICENSE.md) for more.
1 change: 1 addition & 0 deletions main.js
Expand Up @@ -25,6 +25,7 @@

/* global define, brackets, $, window */

//TODO: ignore flake8 `indentation contains tabs` if Brackets uses tabs
//TODO: run flake8 from project root, as well as python utils.
//TODO: fix sphinx' special roles uses in inline documentation - maybe just use Sphinx?
//TODO: move flake8 to standart API, if it'll ever get API.
Expand Down
Binary file added screenshots/autocompletion.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/docs.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/lint.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d6d0c9c

Please sign in to comment.