You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improving getting started instructions in README and minor updates to contributors guide (#605)
* Improved getting started instructions on readme and contributing guide
* Wording changes to README.md
* Mention vscode warning in contributor guide
* Incorporated Chet's feedback: sentence casing, header size, see all commands
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
### Prerequisites
6
6
7
-
1. Node.js (>= 8.9.1, < 9.0.0)
7
+
1. Node.js (>= 8.9.1, < 9.0.0), and [Yarn](https://yarnpkg.com/lang/en/docs/install/)
8
8
2. Python 2.7 or later (required only for testing the extension and running unit tests)
9
9
3. Windows, OS X or Linux
10
10
4. Visual Studio Code
@@ -20,6 +20,8 @@ cd vscode-python
20
20
yarn install
21
21
```
22
22
23
+
You may see warnings that ```The engine "vscode" appears to be invalid.```, you can ignore these.
24
+
23
25
### Incremental Build
24
26
25
27
Run the `Compile` and `Hygiene` build Tasks from the [Command Palette](https://code.visualstudio.com/docs/editor/tasks) (short cut `CTRL+SHIFT+B` or `⇧⌘B`)
Copy file name to clipboardExpand all lines: README.md
+51-41Lines changed: 51 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,49 @@
1
1
# Python extension for Visual Studio Code
2
2
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)
6
-
* Auto indenting
7
-
* Code formatting ([autopep8](https://pypi.io/project/autopep8/), [yapf](https://pypi.io/project/yapf/), with config files)
* 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/), [nose](https://pypi.io/project/nose/), with config files)
12
-
* Execute file or code in a python terminal
13
-
* Snippets
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_), including features such as linting, debugging, IntelliSense, code navigation, code formatting, refactoring, unit tests, snippets, and more!
4
+
5
+
## Quick start
6
+
7
+
***Step 1.**[Install a supported version of Python on your system](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) (note: that the system install of Python on macOS is not supported).
8
+
***Step 2.** Install the Python extension for Visual Studio Code.
9
+
***Step 3.** Open or create a Python file and start coding!
10
+
11
+
## Optional steps
12
+
***Step 4.**[Install a linter](https://code.visualstudio.com/docs/python/linting) to get errors and warnings -- you can further customize linting rules to fit your needs.
13
+
***Step 5.** Select your preferred Python interpreter/version/environment using the `Select Interpreter` command.
14
+
+ By default we use the one that's on your path.
15
+
+ If you have a workspace open you can also click in the status bar to change the interpreter.
16
+
***Step 6.** Install `ctags` for Workspace Symbols, from [here](http://ctags.sourceforge.net/), or using `brew install ctags` on macOS.
14
17
15
-
## Quick Start
18
+
For more information you can:
19
+
*[Follow our Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) with step-by-step instructions for building a simple app.
20
+
* Check out the [Python documentation on the VS Code site](https://code.visualstudio.com/docs/languages/python) for general information about using the extension.
16
21
17
-
* Install the extension
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/environment (use the command `Select Workspace Interpreter` or look in the status bar)
Open the Command Palette (Command+Shift+P on macOS and Ctrl+Shift+P on Windows/Linux) and type in one of the following commands:
24
25
25
-
For further information and details continue through to the [documentation](https://code.visualstudio.com/docs/languages/python).
26
+
Command | Description
27
+
--- | ---
28
+
```Python: Select Interpreter``` | Switch between Python interpreters, versions, and environments.
29
+
```Python: Start REPL``` | Start an interactive Python REPL using the selected interpreter in the VS Code terminal.
30
+
```Python: Run Python File in Terminal``` | Runs the active Python file in the VS Code terminal. You can also run a Python file by right-clicking on the file and selecting ```Run Python File in Terminal```.
31
+
```Python: Select Linter``` | Switch from PyLint to flake8 or other supported linters.
26
32
27
-
## Questions, Issues, Feature Requests, and Contributions
33
+
To see all available Python commands, open the Command Palette and type ```Python```.
34
+
35
+
## Supported locales
36
+
37
+
The extension is available in multiple languages thanks to external
38
+
contributors (if you would like to contribute a translation, see the
39
+
[pull request which added simplified Chinese](https://github.com/Microsoft/vscode-python/pull/240)):
40
+
41
+
*`en`
42
+
*`ja`
43
+
*`ru`
44
+
*`zh-cn`
45
+
46
+
## Questions, issues, feature requests, and contributions
28
47
29
48
* If you have a question about how to accomplish something with the extension, please [ask on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+python)
30
49
* If you come across a problem with the extension, please [file an issue](https://github.com/microsoft/vscode-python)
@@ -33,15 +52,15 @@ For further information and details continue through to the [documentation](http
33
52
- If someone has already [file an issue](https://github.com/Microsoft/vscode-python) that encompasses your feedback, please leave a 👍/👎 reaction on the issue
+ Code definition (Peek and hover definition, View signatures)
42
61
+ Rename refactoring
43
62
+ Sorting import statements (use the `Python: Sort Imports` command)
44
-
* Intellisense and Autocomplete (including PEP 484 support)
63
+
* Intellisense and autocomplete (including PEP 484 and PEP 526 support)
45
64
+ Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc.; use the setting `python.autoComplete.extraPaths = []`)
46
65
* Code formatting
47
66
+ Auto formatting of code upon saving changes (default to 'Off')
@@ -50,30 +69,30 @@ For further information and details continue through to the [documentation](http
50
69
+ 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)
51
70
* Debugging
52
71
+ Watch window
53
-
+ Evaluate Expressions
72
+
+ Evaluate expressions
54
73
+ Step through code ("Step in", "Step out", "Continue")
55
-
+ Add/remove break points
74
+
+ Add/remove breakpoints
56
75
+ Local variables and arguments
57
76
+ Multi-threaded applications
58
77
+ Web applications (such as [Flask](http://flask.pocoo.org/) & [Django](https://www.djangoproject.com/), with template debugging)
+ Debugging in the integrated or external terminal window
64
83
+ Debugging as sudo
65
-
* Unit Testing
84
+
* Unit testing
66
85
+ 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/)
67
86
+ Ability to run all failed tests, individual tests
68
87
+ Debugging unit tests
69
88
* Snippets
70
89
* Miscellaneous
71
90
+ Running a file or selected text in python terminal
0 commit comments