|
1 | | -# Python |
| 1 | +This repository is no longer maintained. I will continue my work on this extension on the corresponding [Microsoft fork](https://github.com/Microsoft/vscode-python). |
2 | 2 |
|
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) |
6 | | -* Auto indenting |
7 | | -* 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)) |
9 | | -* Viewing references, code navigation, view signature |
10 | | -* 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) |
12 | | -* Execute file or code in a python terminal |
13 | | -* Local help file (offline documentation) |
14 | | -* Snippets |
15 | | - |
16 | | -## Quick Start |
17 | | -* 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)) |
22 | | - |
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). |
25 | | - |
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) |
31 | | - |
32 | | -## 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) |
37 | | - + 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) |
51 | | - + 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) |
63 | | - + Watch window |
64 | | - + Evaluate Expressions |
65 | | - + Step through code (Step in, Step out, Continue) |
66 | | - + Add/remove break points |
67 | | - + Local variables and arguments |
68 | | - + Multiple Threads and Web Applications (such as Flask, Django, with template debugging) |
69 | | - + Expanding values (viewing children, properties, etc) |
70 | | - + Conditional break points |
71 | | - + Remote debugging (over SSH) |
72 | | - + Google App Engine |
73 | | - + Debugging in the integrated or external terminal window |
74 | | - + 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 |
80 | | -* Snippets |
81 | | -* Miscellaneous |
82 | | - + Running a file or selected text in python terminal |
83 | | -* 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) |
88 | | - |
89 | | - |
90 | | - |
91 | | - |
92 | | - |
93 | | - |
94 | | - |
95 | | - |
96 | | - |
97 | | - |
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/DonJayamanne/pythonVSCode) |
119 | | - |
120 | | - |
121 | | -## License |
122 | | - |
123 | | -[MIT](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/LICENSE) |
0 commit comments