Skip to content

Commit 2aded04

Browse files
authored
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
1 parent 36b3050 commit 2aded04

File tree

2 files changed

+54
-42
lines changed

2 files changed

+54
-42
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Prerequisites
66

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/)
88
2. Python 2.7 or later (required only for testing the extension and running unit tests)
99
3. Windows, OS X or Linux
1010
4. Visual Studio Code
@@ -20,6 +20,8 @@ cd vscode-python
2020
yarn install
2121
```
2222

23+
You may see warnings that ```The engine "vscode" appears to be invalid.```, you can ignore these.
24+
2325
### Incremental Build
2426

2527
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`)

README.md

Lines changed: 51 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,49 @@
11
# Python extension for Visual Studio Code
22

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)
8-
* Code refactoring (Rename, Extract Variable, Extract Method, 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/), [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.
1417

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.
1621

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)
22+
## Useful commands
2223

23-
## [Documentation](https://code.visualstudio.com/docs/languages/python)
24+
Open the Command Palette (Command+Shift+P on macOS and Ctrl+Shift+P on Windows/Linux) and type in one of the following commands:
2425

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.
2632

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
2847

2948
* 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)
3049
* 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
3352
- If someone has already [file an issue](https://github.com/Microsoft/vscode-python) that encompasses your feedback, please leave a 👍/👎 reaction on the issue
3453
- Otherwise please file a new issue
3554

36-
## Feature Details
55+
## Feature details
3756

38-
* IDE-like Features
57+
* IDE-like features
3958
+ Automatic indenting
4059
+ Code navigation ("Go to", "Find all" references)
4160
+ Code definition (Peek and hover definition, View signatures)
4261
+ Rename refactoring
4362
+ 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)
4564
+ Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc.; use the setting `python.autoComplete.extraPaths = []`)
4665
* Code formatting
4766
+ 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
5069
+ 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)
5170
* Debugging
5271
+ Watch window
53-
+ Evaluate Expressions
72+
+ Evaluate expressions
5473
+ Step through code ("Step in", "Step out", "Continue")
55-
+ Add/remove break points
74+
+ Add/remove breakpoints
5675
+ Local variables and arguments
5776
+ Multi-threaded applications
5877
+ Web applications (such as [Flask](http://flask.pocoo.org/) & [Django](https://www.djangoproject.com/), with template debugging)
5978
+ Expanding values (viewing children, properties, etc)
60-
+ Conditional break points
79+
+ Conditional breakpoints
6180
+ Remote debugging (over SSH)
6281
+ Google App Engine
6382
+ Debugging in the integrated or external terminal window
6483
+ Debugging as sudo
65-
* Unit Testing
84+
* Unit testing
6685
+ 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/)
6786
+ Ability to run all failed tests, individual tests
6887
+ Debugging unit tests
6988
* Snippets
7089
* Miscellaneous
7190
+ Running a file or selected text in python terminal
7291
* Refactoring
73-
+ Rename Refactorings
74-
+ Extract Variable Refactorings
75-
+ Extract Method Refactorings
76-
+ Sort Imports
92+
+ Rename refactorings
93+
+ Extract variable refactorings
94+
+ Extract method refactorings
95+
+ Sort imports
7796

7897
![General Features](https://raw.githubusercontent.com/microsoft/vscode-python/master/images/general.gif)
7998

@@ -82,18 +101,9 @@ For further information and details continue through to the [documentation](http
82101
![Unit Tests](https://raw.githubusercontent.com/microsoft/vscode-python/master/images/unittest.gif)
83102

84103

85-
## Supported locales
86-
87-
The extension is available in multiple languages thanks to external
88-
contributors (if you would like to contribute a translation, see the
89-
[pull request which added simplified Chinese](https://github.com/Microsoft/vscode-python/pull/240)):
90104

91-
* `en`
92-
* `ja`
93-
* `ru`
94-
* `zh-cn`
95105

96-
## Data/Telemetry
106+
## Data and telemetry
97107

98108
The Microsoft Python Extension for Visual Studio Code collects usage
99109
data and sends it to Microsoft to help improve our products and

0 commit comments

Comments
 (0)