|
1 |
| -# Python |
| 1 | +# [Python](http://donjayamanne.github.io/pythonVSCode/) |
2 | 2 | Linting, Debugging (multi-threaded, web apps, remote), Intellisense, auto-completion, code formatting, snippets, unit testing, and more.
|
3 | 3 |
|
4 |
| -##[Documentation](https://github.com/DonJayamanne/pythonVSCode/wiki) |
5 |
| -###Getting Started |
| 4 | +##Quick Start |
6 | 5 | * Install the extension
|
7 |
| -* If using a custom Python Version or a Virtual Environment, then configure the path to the python executable in settings.json ([further details here](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version#python-version-used-for-intellisense-autocomplete-linting-formatting-etc)) |
8 |
| -###[Troubleshooting guide](https://github.com/DonJayamanne/pythonVSCode/wiki/Troubleshooting) |
| 6 | +* If Python is in the current path |
| 7 | + + You're ready to use it. |
| 8 | +* If using a custom Python Version or a Virtual Environment |
| 9 | + + Configure the path to the python executable in python.pythonPath of the settings.json file ([further details here](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version#python-version-used-for-intellisense-autocomplete-linting-formatting-etc)) |
9 | 10 |
|
10 |
| -###Feature Requests and contributions |
11 |
| -* Contributions are always welcome. Fork it, make the changes and create a pull request |
12 |
| -* Your feedback will make this a better product, so all feedback is appreciated and welcome. |
| 11 | +For further information and details continue through to the [documenetation](https://github.com/DonJayamanne/pythonVSCode/wiki). |
| 12 | + |
| 13 | +##Feature Requests and contributions |
| 14 | +* Contributions are always welcome. Fork it, modify it and create a pull request. |
| 15 | +* Any and all feedback is appreciated and welcome. |
13 | 16 | + Please feel free to [add suggestions here](https://github.com/DonJayamanne/pythonVSCode/issues/183)
|
14 | 17 |
|
15 |
| -###Roadmap |
| 18 | +##Features |
| 19 | +* Linting (Prospector, PyLint, Pep8, Flake8, pydocstyle with config files and plugins) |
| 20 | +* Intellisense (autocompletion) |
| 21 | +* Auto indenting |
| 22 | +* Code formatting (autopep8, yapf, with config files) |
| 23 | +* Renaming, Viewing references, and code navigation |
| 24 | +* View signature and similar by hovering over a function or method |
| 25 | +* Excellent debugging suppot (variables, arguments, expressions, watch window, stack information, break points, remote debugging, mutliple threads) |
| 26 | +* Unit testing (unittests and nosetests, with config files) |
| 27 | +* Sorting imports |
| 28 | +* Snippets |
| 29 | + |
| 30 | +##[Roadmap](https://github.com/DonJayamanne/pythonVSCode/issues/183) |
16 | 31 | _Please note, not all of these feature may be developed.
|
17 |
| -Your feedback is crucial in prioritizing the items and in determining whether we focus our attention to some other feature request(s)._ |
| 32 | +Your feedback is crucial in prioritizing the items and in determining whether we shift focus our attention to some other feature request(s)._ |
18 | 33 | * Intellisense and Linting
|
19 | 34 | + Performance improvements
|
20 | 35 | + Linting as you type
|
21 | 36 | + Context actions for some linter messages
|
22 |
| -* Miscellaneous tools |
23 |
| - + Code coverage |
24 |
| - + Profiler |
25 |
| -* Remote Interpretter |
26 |
| -* Integrating IPython |
| 37 | + + Remote Interpretter |
27 | 38 | * Miscellaneous IDE enhancements
|
28 | 39 | + Code Refactoring
|
29 | 40 | + Autogenerate docstring
|
30 | 41 | + Documentation viewer
|
31 | 42 | + Improved integration of Unit Tests
|
| 43 | +* Integration |
| 44 | + + Code coverage |
| 45 | + + Profiler |
| 46 | + + Integrating IPython |
32 | 47 | * Debugging enhancements
|
33 | 48 | + Integration with VS Code Terminal window
|
34 | 49 | + Securely debugging Python applications in the cloud (Azure, AWS or Google Cloud)
|
35 | 50 | + Remote debugging over SSH
|
36 | 51 |
|
37 |
| -##Features |
38 |
| -* Linting (Prospector, PyLint, Pep8, Flake8, pydocstyle with config files and plugins) |
39 |
| -* Intellisense and autocompletion |
40 |
| -* Auto indenting |
41 |
| -* Code formatting (autopep8, yapf, with config files) |
42 |
| -* Renaming, Viewing references, Going to definitions, Go to Symbols |
43 |
| -* View signature and similar by hovering over a function or method |
44 |
| -* Debugging with support for local variables, arguments, expressions, watch window, stack information, break points |
45 |
| -* Debugging Multiple threads (Web Applications - Flask, etc) and expanding values (on Windows and Mac) |
46 |
| -* Debugging remote processes (attaching to local and remote process) |
47 |
| -* Debugging with support for shebang (windows) |
48 |
| -* Debugging with custom environment variables |
49 |
| -* Unit testing (unittests and nosetests, with config files) |
50 |
| -* Sorting imports |
51 |
| -* Snippets |
52 |
| - |
53 | 52 | ##[Issues and Feature Requests](https://github.com/DonJayamanne/pythonVSCode/issues)
|
54 | 53 |
|
55 | 54 | ## Feature Details
|
@@ -111,12 +110,12 @@ Your feedback is crucial in prioritizing the items and in determining whether we
|
111 | 110 | ## Change Log
|
112 | 111 |
|
113 | 112 | ### Version 0.3.12
|
114 |
| -* Changes to how linters and formatters are executed (optimizations and changes to settings to separate out the command line arguments) [#178](https://github.com/DonJayamanne/pythonVSCode/issues/178)[#163](https://github.com/DonJayamanne/pythonVSCode/issues/163) |
| 113 | +* Changes to how linters and formatters are executed (optimizations and changes to settings to separate out the command line arguments) [#178](https://github.com/DonJayamanne/pythonVSCode/issues/178), [#163](https://github.com/DonJayamanne/pythonVSCode/issues/163) |
115 | 114 | * Fix to support Unicode characters in debugger [#102](https://github.com/DonJayamanne/pythonVSCode/issues/102)
|
116 | 115 | * Added support for {workspaceRoot} in Path settings defined in settings.js [#148](https://github.com/DonJayamanne/pythonVSCode/issues/148)
|
117 | 116 | * Resolving path of linters and formatters based on python path defined in settings.json [#148](https://github.com/DonJayamanne/pythonVSCode/issues/148)
|
118 | 117 | * Better handling of Paths to python executable and related tools (linters, formatters) in virtual environments [#148](https://github.com/DonJayamanne/pythonVSCode/issues/148)
|
119 |
| -* Added support for configurationDone event in debug adapter [#168](https://github.com/DonJayamanne/pythonVSCode/issues/168)[#145](https://github.com/DonJayamanne/pythonVSCode/issues/145) |
| 118 | +* Added support for configurationDone event in debug adapter [#168](https://github.com/DonJayamanne/pythonVSCode/issues/168), [#145](https://github.com/DonJayamanne/pythonVSCode/issues/145) |
120 | 119 |
|
121 | 120 | ### Version 0.3.11
|
122 | 121 | * Added support for telemetry [#156](https://github.com/DonJayamanne/pythonVSCode/issues/156)
|
|
0 commit comments