Skip to content

Commit 522e2d6

Browse files
DonJayamanneDonJayamanne
committed
Bumped version and updated readme for build
1 parent 662e051 commit 522e2d6

File tree

2 files changed

+57
-16
lines changed

2 files changed

+57
-16
lines changed

‎README.md‎

Lines changed: 55 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,61 @@
11
# Python
2-
Linting, Debugging, Intellisense, auto-completion, code formatting, rename references, view references, go to definition, and the like
2+
Linting, Debugging, Intellisense, auto-completion, code formatting, snippets, and more.
33
Works on both Windows and Mac.
44

55
##Features
6-
* Linting (using PyLint and/or Pep8 with support for configuration files)
7-
* Intellisense and auto completion
8-
* Code formatting (using Autopep8 or yapf, defaults to autopep8, with support for configuration files)
9-
* Renaming
10-
* Viewing references
11-
* Going to definitions
6+
* Linting (PyLint, Pep8 with support for config files)
7+
* Intellisense and autocompletion
8+
* Code formatting (autopep8, yapf, with support for config files)
9+
* Renaming, Viewing references, Going to definitions, Go to Symbols
1210
* View signature and similar by hovering over a function or method
1311
* Debugging with support for local & global variables, arguments, expressions, watch window, stack information, break points
14-
1512
* Sorting imports
13+
* Snippets
1614

1715
## Issues, Feedback and Suggestions
1816
[Gitbub Issues](https://github.com/DonJayamanne/pythonVSCode/issues)
1917

18+
## Feature Details (with confiuration)
19+
* IDE Features
20+
* - Rename and navigate to symbols
21+
* - Go to, Peek and hover definition
22+
* - Find all references
23+
* - View Signature
24+
* - Sorting Import statements (use "Python: Sort Imports" command)
25+
* Intellisense and Autocomplete
26+
* - Full intellisense
27+
* - Support for docstring
28+
* Code formatting
29+
* - Use either yapf or autopep8 for code formatting (defaults to autopep8)
30+
* - auutopep8 configuration files supported
31+
* - yapf configuration files supported
32+
* Linting
33+
* - It can be turned off (default is turn it on and use pylint)
34+
* - pylint can be turned off
35+
* - pyliny configuaration files supported
36+
* - pep8 can be turned off
37+
* - pep8 configuaration files supported
38+
* - Different categories of errors reported by pylint can be configured as warnings, errors, information or hits
39+
* - Path to pylint and pep8 can be configured
40+
* - Path to pep8 can be configured through config
41+
* Debuggging
42+
* - Local and Global variables
43+
* - Arguments
44+
* - Watch window
45+
* - Evaluate Expressions
46+
* - Step through code (Step in, Step out, Continue)
47+
* - Add/remove break points
48+
* Snippets
49+
50+
51+
![Image of Generate Features](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/general.gif)
52+
53+
![Image of Go To Definition](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/goToDef.gif)
54+
55+
![Image of Renaming and Find all References](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/rename.gif)
56+
2057
## Requirements
2158
* Python is installed on the current system
22-
* Path to Python is assumed to be in the current environment path.
2359
* Pylint is installed for linting (optional, this can be turned off)
2460
* - Install Pylint as follows:
2561
* - pip install pylint
@@ -30,19 +66,24 @@ Works on both Windows and Mac.
3066
* - pip install pep8
3167
* - pip install --upgrade autopep8
3268

33-
![Image of Generate Features](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/general.gif)
3469

35-
![Image of Go To Definition](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/goToDef.gif)
36-
37-
![Image of Renaming and Find all References](https://raw.githubusercontent.com/DonJayamanne/pythonVSCode/master/images/rename.gif)
70+
## Change Log
3871

72+
### Version 0.1.0
73+
* Fixed linting of files on Mac
74+
* Added support for linting using pep8
75+
* Added configuration support for pep8 and pylint
76+
* Added support for configuring paths for pep8, pylint and autopep8
77+
* Added snippets
78+
* Added support for formatting using yapf
79+
* Added a number of configuration settings
3980

40-
## Chang Log
4181
### Version 0.0.4
4282
* Added support for linting using Pylint (configuring pylint is coming soon)
4383
* Added support for sorting Imports (Using the command "Pythong: Sort Imports")
4484
* Added support for code formatting using Autopep8 (configuring autopep8 is coming soon)
4585
* Added ability to view global variables, arguments, add and remove break points
86+
4687
### Version 0.0.3
4788
* Added support for debugging using PDB
4889

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "python",
33
"displayName": "Python",
4-
"description": "Python debugging, linting, auto complete, code formatting, sorting imports, go to definition, peek definition, signature view, rename symbol, etc",
5-
"version": "0.0.4",
4+
"description": "Linting, Debugging, Intellisense, auto-completion, code formatting, snippets, and more.",
5+
"version": "0.1.0",
66
"publisher": "donjayamanne",
77
"license": "SEE LICENSE IN LICENSE or README.MD",
88
"homepage": "https://github.com/DonJayamanne/pythonVSCode/blob/master/README.md",

0 commit comments

Comments
 (0)