Skip to content

Commit afcac4f

Browse files
authored
Simplify/touch-up README (#8)
1 parent e7c2fdd commit afcac4f

36 files changed

Lines changed: 44 additions & 90 deletions

‎README.md‎

Lines changed: 44 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,126 +1,81 @@
1-
# Python
1+
# Python extension for Visual Studio Code
22

3-
An extension with rich support for the [Python language](https://www.python.org/) (_including Python 3.6_), with features including the following and more:
4-
* Linting ([Prospector](https://pypi.io/project/prospector/), [Pylint](https://pypi.io/project/pylint/), [pycodestyle/pep257/pep8](https://pypi.io/project/pycodestyle/), [Flake8](https://pypi.io/project/flake8/), [pylama](https://github.com/klen/pylama), [pydocstyle](https://pypi.io/project/pydocstyle/), [mypy](http://mypy-lang.org/) with config files and plugins)
5-
* Intellisense (autocompletion with support for PEP-0484 and PEP 526)
3+
A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) with rich support for the [Python language](https://www.python.org/) (_including Python 3.6_), with features including the following and more:
4+
* Linting ([Prospector](https://pypi.io/project/prospector/), [Pylint](https://pypi.io/project/pylint/), [pycodestyle](https://pypi.io/project/pycodestyle/), [Flake8](https://pypi.io/project/flake8/), [pylama](https://github.com/klen/pylama), [pydocstyle](https://pypi.io/project/pydocstyle/), [mypy](http://mypy-lang.org/) with config files and plugins)
5+
* Intellisense (autocompletion with support for PEP 484 and PEP 526)
66
* Auto indenting
77
* Code formatting ([autopep8](https://pypi.io/project/autopep8/), [yapf](https://pypi.io/project/yapf/), with config files)
8-
* Code refactoring ([Rename](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Rename), [Extract Variable](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Extract-Variable), [Extract Method](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Extract-Method), [Sort Imports](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Sort-Imports))
8+
* Code refactoring (Rename, Extract Variable, Extract Method,Sort Imports)
99
* Viewing references, code navigation, view signature
1010
* Excellent debugging support (remote debugging over SSH, mutliple threads, django, flask)
11-
* Running and debugging Unit tests ([unittest](https://docs.python.org/3/library/unittest.html#module-unittest), [pytest](https://pypi.io/project/pytest/), [nosetests](https://pypi.io/project/nose/), with config files)
11+
* Running and debugging Unit tests ([unittest](https://docs.python.org/3/library/unittest.html#module-unittest), [pytest](https://pypi.io/project/pytest/), [nose](https://pypi.io/project/nose/), with config files)
1212
* Execute file or code in a python terminal
1313
* Local help file (offline documentation)
1414
* Snippets
1515

1616
## Quick Start
1717
* Install the extension
18-
* optionally install `ctags` for Workspace Symbols, from [here](http://ctags.sourceforge.net/), or using `brew install ctags` on OSX.
19-
* If Python is in the current path
20-
+ You're ready to use it.
21-
* To select a different Python Interpreter/Version (or use Virtual Environment), use the command [```Select Workspace Interpreter```](https://github.com/DonJayamanne/pythonVSCode/wiki/Miscellaneous#select-an-interpreter))
18+
* optionally install `ctags` for Workspace Symbols, from [here](http://ctags.sourceforge.net/), or using `brew install ctags` on macOS
19+
* Select your Python interpreter
20+
+ If it's already in your path then you're set
21+
+ Otherwise, to select a different Python Interpreter/Version (or use a virtual environment), use the command `Select Workspace Interpreter`)
2222

23-
## [Documentation](https://github.com/DonJayamanne/pythonVSCode/wiki)
24-
For further information and details continue through to the [documentation](https://github.com/DonJayamanne/pythonVSCode/wiki).
23+
## [Documentation](https://aka.ms/pvsc-docs)
24+
For further information and details continue through to the [documentation](https://aka.ms/pvsc-docs).
2525

26-
## [Issues, Feature Requests and Contributions](https://github.com/DonJayamanne/pythonVSCode/issues)
27-
* Contributions are always welcome. Fork it, modify it and create a pull request.
28-
+ Details on contributing can be found [here](https://github.com/DonJayamanne/pythonVSCode/wiki/Contribution)
29-
* Any and all feedback is appreciated and welcome.
30-
+ Please feel free to [add suggestions here](https://github.com/DonJayamanne/pythonVSCode/issues/183)
26+
## Issues, Feature Requests, and Contributions
27+
* If you come across a problem with the extension please [file an issue](https://github.com/microsoft/vscode-python)
28+
* Contributions are always welcome! Please see our [contributing guide](https://github.com/Microsoft/vscode-python/blob/master/CONTRIBUTING.md) for more details
29+
* Any and all feedback is appreciated and welcome!
30+
- If someone has already [file an issue](https://github.com/Microsoft/vscode-python) that encompasses your feedback, please leave a 👍/👎 reaction on the issue
31+
- Othewise please file a new issue
3132

3233
## Feature Details
33-
* IDE Features
34-
+ Auto indenting
35-
+ Code navigation (Go to, Find all references)
36-
+ Code definition (Peek and hover definition, View Signature)
34+
* IDE-like Features
35+
+ Automatic indenting
36+
+ Code navigation ("Go to", "Find all" references)
37+
+ Code definition (Peek and hover definition, View signatures)
3738
+ Rename refactoring
38-
+ Sorting Import statements (use "Python: Sort Imports" command)
39-
* [Intellisense and Autocomplete](https://github.com/DonJayamanne/pythonVSCode/wiki/Autocomplete-Intellisense) with support for PEP-0484
40-
+ Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc.)
41-
+ Use the `setting python.autoComplete.extraPaths = []`
42-
+ For instance getting autocomplete/intellisense for Google App Engine, add the following to your settings file:
43-
```json
44-
"python.autoComplete.extraPaths": [
45-
"C:/Program Files (x86)/Google/google_appengine",
46-
"C:/Program Files (x86)/Google/google_appengine/lib" ]
47-
```
48-
* [Scientific tools (Jupyter/IPython)](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python)
49-
+ This functionality has been moved into a separate extension [Jupyter](https://marketplace.visualstudio.com/items?itemName=donjayamanne.jupyter)
50-
* [Code formatting](https://github.com/DonJayamanne/pythonVSCode/wiki/Formatting)
39+
+ Sorting import statements (use the `Python: Sort Imports` command)
40+
* Intellisense and Autocomplete (including PEP 484 support)
41+
+ Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc.; use the setting `python.autoComplete.extraPaths = []`)
42+
* Code formatting
5143
+ Auto formatting of code upon saving changes (default to 'Off')
52-
+ Use either yapf or autopep8 for code formatting (defaults to autopep8)
53-
* [Linting](https://github.com/DonJayamanne/pythonVSCode/wiki/Linting)
54-
+ It can be turned off (default is to be turned on and use pylint)
55-
+ Multiple linters supported (along with support for configuration files for each linter)
56-
+ Supported linters include pylint, pep8, flake8, pydocstyle, prospector
57-
+ Paths to each of the linters can be optionally configured
58-
+ Custom plugins such as pylint plugin for Django can be easily used by modifying the settings as follows:
59-
```json
60-
"python.linting.pylintArgs": ["--load-plugins", "pylint_django"]
61-
```
62-
* [Debugging](https://github.com/DonJayamanne/pythonVSCode/wiki/Debugging)
44+
+ Use either [yapf](https://pypi.io/project/yapf/) or [autopep8](https://pypi.io/project/autopep8/) for code formatting (defaults to autopep8)
45+
* Linting
46+
+ Support for multiple linters with custom settings (default is [Pylint](https://pypi.io/project/pylint/), but [Prospector](https://pypi.io/project/prospector/), [pycodestyle](https://pypi.io/project/pycodestyle/), [Flake8](https://pypi.io/project/flake8/), [pylama](https://github.com/klen/pylama), [pydocstyle](https://pypi.io/project/pydocstyle/), and [mypy](http://mypy-lang.org/) are also supported)
47+
* Debugging
6348
+ Watch window
6449
+ Evaluate Expressions
65-
+ Step through code (Step in, Step out, Continue)
50+
+ Step through code ("Step in", "Step out", "Continue")
6651
+ Add/remove break points
6752
+ Local variables and arguments
68-
+ Multiple Threads and Web Applications (such as Flask, Django, with template debugging)
53+
+ Multi-threaded applications
54+
+ Web applications (such as [Flask](http://flask.pocoo.org/) & [Django](https://www.djangoproject.com/), with template debugging)
6955
+ Expanding values (viewing children, properties, etc)
7056
+ Conditional break points
7157
+ Remote debugging (over SSH)
7258
+ Google App Engine
7359
+ Debugging in the integrated or external terminal window
7460
+ Debugging as sudo
75-
* [Unit Testing](https://github.com/DonJayamanne/pythonVSCode/wiki/UnitTests)
76-
+ Support for unittests, nosetests and pytest
77-
+ Test results are displayed in the "Python" output window
78-
+ Run failed tests, individual tests
79-
+ Debugging unittests
61+
* Unit Testing
62+
+ Support for [unittest](https://docs.python.org/3/library/unittest.html#module-unittest), [pytest](https://pypi.io/project/pytest/), and [nose](https://pypi.io/project/nose/)
63+
+ Ability to run all failed tests, individual tests
64+
+ Debugging unit tests
8065
* Snippets
8166
* Miscellaneous
8267
+ Running a file or selected text in python terminal
8368
* Refactoring
84-
+ [Rename Refactorings](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Rename)
85-
+ [Extract Variable Refactorings](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Extract-Variable)
86-
+ [Extract Method Refactorings](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Extract-Method)
87-
+ [Sort Imports](https://github.com/DonJayamanne/pythonVSCode/wiki/Refactoring:-Sort-Imports)
69+
+ Rename Refactorings
70+
+ Extract Variable Refactorings
71+
+ Extract Method Refactorings
72+
+ Sort Imports
8873

89-
![Generate Features](https://raw.githubusercontent.com/DonJayamanne/pythonVSCodeDocs/master/images/general.gif)
74+
![General Features](https://raw.githubusercontent.com/microsoft/vscode-python/master/images/general.gif)
9075

91-
![Debugging](https://raw.githubusercontent.com/DonJayamanne/pythonVSCodeDocs/master/images/debugDemo.gif)
76+
![Debugging](https://raw.githubusercontent.com/microsoft/vscode-python/master/images/debugDemo.gif)
9277

93-
![Unit Tests](https://raw.githubusercontent.com/DonJayamanne/pythonVSCodeDocs/master/images/unittest.gif)
94-
95-
![Scientific Tools](https://raw.githubusercontent.com/DonJayamanne/pythonVSCodeDocs/master/images/jupyter/examples.gif)
96-
97-
![Local Help](https://raw.githubusercontent.com/DonJayamanne/pythonVSCodeDocs/master/images/help.gif)
98-
99-
## [Roadmap](https://donjayamanne.github.io/pythonVSCodeDocs/docs/roadmap/)
100-
101-
## [Change Log](https://github.com/DonJayamanne/pythonVSCode/blob/master/CHANGELOG.md)
102-
103-
### Version 0.7.0 (3 August 2017)
104-
* Displaying internal documntation [#1008](https://github.com/DonJayamanne/pythonVSCode/issues/1008), [#10860](https://github.com/DonJayamanne/pythonVSCode/issues/10860)
105-
* Fixes to 'async with' snippet [#1108](https://github.com/DonJayamanne/pythonVSCode/pull/1108), [#996](https://github.com/DonJayamanne/pythonVSCode/issues/996)
106-
* Add support for environment variable in unit tests [#1074](https://github.com/DonJayamanne/pythonVSCode/issues/1074)
107-
* Fixes to unit test code lenses not being displayed [#1115](https://github.com/DonJayamanne/pythonVSCode/issues/1115)
108-
* Fix to empty brackets being added [#1110](https://github.com/DonJayamanne/pythonVSCode/issues/1110), [#1031](https://github.com/DonJayamanne/pythonVSCode/issues/1031)
109-
* Fix debugging of Django applications [#819](https://github.com/DonJayamanne/pythonVSCode/issues/819), [#999](https://github.com/DonJayamanne/pythonVSCode/issues/999)
110-
* Update isort to the latest version [#1134](https://github.com/DonJayamanne/pythonVSCode/issues/1134), [#1135](https://github.com/DonJayamanne/pythonVSCode/pull/1135)
111-
* Fix issue causing intellisense and similar functionality to stop working [#1072](https://github.com/DonJayamanne/pythonVSCode/issues/1072), [#1118](https://github.com/DonJayamanne/pythonVSCode/pull/1118), [#1089](https://github.com/DonJayamanne/pythonVSCode/issues/1089)
112-
* Bunch of unit tests and code cleanup
113-
* Resolve issue where navigation to decorated function goes to decorator [#742](https://github.com/DonJayamanne/pythonVSCode/issues/742)
114-
* Go to symbol in workspace leads to nonexisting files [#816](https://github.com/DonJayamanne/pythonVSCode/issues/816), [#829](https://github.com/DonJayamanne/pythonVSCode/issues/829)
115-
116-
## Source
117-
118-
[GitHub](https://github.com/microsoft/vscode-python)
119-
120-
121-
## License
122-
123-
[MIT](https://raw.githubusercontent.com/microsoft/vscode-python/master/LICENSE)
78+
![Unit Tests](https://raw.githubusercontent.com/microsoft/vscode-python/master/images/unittest.gif)
12479

12580

12681
## Data/Telemetry

‎images/break.gif‎

-365 KB
Binary file not shown.

‎images/commands.png‎

-88.2 KB
Binary file not shown.
-1.26 MB
Binary file not shown.

‎images/debugDemo.gif‎

4.69 MB
Loading

‎images/debugGAE.gif‎

-8.98 MB
Binary file not shown.

‎images/debugUserInput.gif‎

-1.46 MB
Binary file not shown.

‎images/flaskDebugging.gif‎

-1.08 MB
Binary file not shown.

‎images/general.gif‎

2.62 MB
Loading

‎images/goToDef.gif‎

-2.23 MB
Binary file not shown.

0 commit comments

Comments
 (0)