Skip to content

Commit 2172450

Browse files
author
Jill M. Nolan
committed
updated README and started CHANGELOG and TODO
1 parent bd061c4 commit 2172450

3 files changed

Lines changed: 129 additions & 50 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
All notable changes to the "python-essentials" extension pack will be documented in this file.
44

5-
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
6-
7-
## [Unreleased]
5+
## 0.0.1
86

97
- Initial release
8+
9+
## 0.0.2
10+
11+
- Reorganized the README document by (1) categorizing Extensions alphabetically, (2) reorganizing the Sections, (3) retitle the Sections when appropriate, (4) added YouTube tutorials, (5) added Disclaimer, (6) expanded Notes, (7) referenced Extension Packs published in VSCode Marketplace, (8) reworte Attributions, and (9) added VSCode Tips and Tricks.

README.md

Lines changed: 111 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# README
1+
# Python Essentials, a Visual Studio Code extension package for Python Development
22

33
## Introduction
44

@@ -8,106 +8,170 @@ Are you tired of reinstalling extensions on each of your computer(s)? How about
88

99
Glad, that you've asked! Please find the supervening extensions. Of course, I always love to hear your suggestions to improve this extension package. To do so, please create a new issue in the [**Issues Section**](https://github.com/jillmnolan/python-essentials/issues). After all, the ultimate goal for this extension pack is **convenience** at the click of one button.
1010

11+
### Recommended Theme for Python Development
12+
1113
* [**Chromodynamics Theme**](https://marketplace.visualstudio.com/items?itemName=magicstack.Chromodynamics): A **VSCode plugin** extends **Python programming** in **VSCode** through *a highly recommended (at least, from yours truly!)* **dark color scheme** from [**MagicStack**](https://github.com/MagicStack). **Note:** This works well with [**MagicPython**](https://github.com/MagicStack/MagicPython), which is included below. :-)
1214

15+
### Recommended Extensions for Python Development
16+
17+
* [**Django**](https://marketplace.visualstudio.com/items?itemName=batisteo.vscode-django): A **VSCode plugin** that provides "beautiful" **syntax** and **scoped snippets**.
18+
19+
* [**Jinja**](https://marketplace.visualstudio.com/items?itemName=wholroyd.jinja): A **VSCode plugin** that supports **Jinja template language** support, including **language colorization** support, including but not limited to **type annotations**, **f-strings**, and **regular expressions**.
20+
21+
* [**Live Share Extension Pack**](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack): An **official VSCode extension pack** that enable real-time collaborative development, including integrated [**audio**](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare-audio) and [**text**](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare) chat, which supports [**various use cases**](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/use-cases).
22+
23+
* [**MagicPython**](https://marketplace.visualstudio.com/items?itemName=magicstack.MagicPython): A **VSCode plugin** that supports **preferences** and **syntax highlighter** for "cutting edge" **Python 3**, whereby serving as a **drop-in replacement** for the default **Python package**.
24+
1325
* [**Python**](https://marketplace.visualstudio.com/items?itemName=ms-python.python): An official **Microsoft VSCode plugin** that provides support for the **Python programming language** albeit for all actively supported **versions**: **2.7, >=3.6**, including **Functionalities**, such as:
1426

27+
* Code Formatting
28+
29+
* Code Navigation
30+
31+
* Debugging
32+
1533
* IntelliSense
34+
35+
* [**Jupyter Notebook**](https://jupyter.org/) Support
1636

1737
* Linting
1838

19-
* Debugging
20-
21-
* Code Navigation
22-
23-
* Code Formatting
24-
25-
* [**Jupyter Notebook**](https://jupyter.org/) Support
26-
2739
* Refactoring
28-
29-
* Variable Explorer
40+
41+
* Snippets
3042

3143
* Test Explorer
3244

33-
* Snippets
34-
35-
* **Note**: Please be advised that you will need a **Python** distribution. Depending on what you utilize Python programming for, I can recommend without hesitation either the official [**Python Distribution**](https://www.python.org/) or [**Anaconda**](https://www.anaconda.com/). **Anaconda** graphical user interace is best for **data science**, **artificial intelligence**, and **machine learning**. Conversely, the official **Python** distribution is best for application development (desktop, web, or GIS). I have included the weblinks to the respective homepages, since usually pages are moved and the direct weblink would be dead. :-(
36-
37-
* [**MagicPython**](https://marketplace.visualstudio.com/items?itemName=magicstack.MagicPython): A **VSCode plugin** that supports **preferences** and **syntax highlighter** for "cutting edge" **Python 3**, whereby serving as a **drop-in replacement** for the default **Python package**.
38-
39-
* [**Jinja**](https://marketplace.visualstudio.com/items?itemName=wholroyd.jinja): A **VSCode plugin** that supports **Jinja template language** support, including **language colorization** support, including but not limited to **type annotations**, **f-strings**, and **regular expressions**.
40-
41-
* [**Django**](https://marketplace.visualstudio.com/items?itemName=batisteo.vscode-django): A **VSCode plugin** that provides "beautiful" **syntax** and **scoped snippets**.
45+
* Variable Explorer
4246

43-
* [**Visual Studio IntelliCode**](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode): A **VSCode plugin** that provides **AI-assisted development features** for **Python**, with **insights** based on understanding your **code context** combined with **machine learning**.
47+
* **Note**: Please be advised that you will need a **Python** distribution. Depending on what you utilize Python programming for, I can recommend without hesitation either the official [**Python Distribution**](https://www.python.org/) or [**Anaconda**](https://www.anaconda.com/). **Anaconda** graphical user interace is best for **data science**, **artificial intelligence**, and **machine learning**. Conversely, the official **Python** distribution is best for application development (desktop, web, or GIS). I have included the weblinks to the respective homepages, since usually pages are moved and the direct weblink would be dead. :-(
4448

4549
* [**Python Test Explorer for VSCode**](https://marketplace.visualstudio.com/items?itemName=LittleFoxTeam.vscode-python-test-adapter): A **VSCode plugin** which allows you to run your **Python** [**Unitest tests**](https://docs.python.org/3/library/unittest.html#module-unittest) and [**Pytest**](https://docs.pytest.org/en/latest/) in the sidebar, with the assistance of yet another plugin [**Test Explorer UI**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer). ;-)
4650

51+
* [**Test Explorer Live Share**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer-liveshare): A VS Code plugin that serves as the "glue" between the previously mentioned [**Test Explorer UI**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer) and [**Live Share Extension Pack**](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack), respectively.
52+
4753
* [**Test Explorer UI**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer): A **VSCode plugin** provides an extensible user interface for running tests. **Note**: This plugin works with a corresponding **Test Adapter** plugin, which for this extension pack is: [**Python Test Explorer for VSCode**](https://marketplace.visualstudio.com/items?itemName=LittleFoxTeam.vscode-python-test-adapter). Moreover, this plugin can be used in [**Live Share**](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare) **sessions** by installing the [**Test Explorer Live Share**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer-liveshare) plugin. No worries, this **Extension Pack** got you've covered. :)
4854

49-
* [**Live Share Extension Pack**](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack): An **official VSCode extension pack** that enable real-time collaborative development, including integrated [**audio**](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare-audio) and [**text**](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare) chat, which supports [**various use cases**](https://docs.microsoft.com/en-us/visualstudio/liveshare/reference/use-cases).
55+
* [**Visual Studio IntelliCode**](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode): A **VSCode plugin** that provides **AI-assisted development features** for **Python**, with **insights** based on understanding your **code context** combined with **machine learning**.
5056

51-
* [**Test Explorer Live Share**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer-liveshare): A VS Code plugin that serves as the "glue" between the previously mentioned [**Test Explorer UI**](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer) and [**Live Share Extension Pack**](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack), respectively.
57+
### Descriptions are coming soon for these Extension Packs! :-)
5258

53-
### Descriptions are coming soon! :-)
59+
* [**AREPL for Python**](https://marketplace.visualstudio.com/items?itemName=almenon.arepl)
5460

55-
* [**PyRight**](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright)
61+
* [**Better Comments**](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
5662

57-
* [**Sync Settings**](https://marketplace.visualstudio.com/items?itemName=shan.code-settings-sync)
63+
* [**Bracket Pair Colorizer 2**](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer-2)
5864

5965
* [**Code Runner**](https://marketplace.visualstudio.com/items?itemName=formulahendry.code-runner)
6066

61-
* [**Guides**](https://marketplace.visualstudio.com/items?itemName=spywhere.guides)
67+
* [**Code Spell Checker**](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
6268

63-
* [**AREPL for Python**](https://marketplace.visualstudio.com/items?itemName=almenon.arepl)
69+
* [**EditorConfig for VS Code**](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
6470

65-
* [**Python Docstring Generator**](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
71+
* [**GitLens — Git supercharged**](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
72+
73+
* [**Guides**](https://marketplace.visualstudio.com/items?itemName=spywhere.guides)
6674

6775
* [**Kite Autocomplete for Python and JavaScript**](https://marketplace.visualstudio.com/items?itemName=kiteco.kite)
6876

69-
* [**EditorConfig for VS Code**](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
77+
* [**Markdown All in One**](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
7078

71-
* [**Code Spell Checker**](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
79+
* [**markdownlint**](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
7280

73-
* [**GitLens — Git supercharged**](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
81+
* [**Markdown TOC**](https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc)
82+
83+
* [**Prettier - Code Formatter**](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
7484

7585
* [**PyDev**](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev)
7686

87+
* [**PyRight**](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright)
88+
89+
* [**Python Docstring Generator**](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
90+
91+
* [**Run on Save**](https://marketplace.visualstudio.com/items?itemName=emeraldwalk.runonsave)
92+
93+
* [**Sync Settings**](https://marketplace.visualstudio.com/items?itemName=shan.code-settings-sync)
94+
7795
* [**TabNine**](https://marketplace.visualstudio.com/items?itemName=TabNine.tabnine-vscode)
7896

79-
* [**Better Comments**](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
97+
* [**WakaTime**](https://marketplace.visualstudio.com/items?itemName=WakaTime.vscode-wakatime)
8098

81-
* [**Bracket Pair Colorizer 2**](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer-2)
99+
* [**YAML**](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
82100

83-
* [**Markdown All in One**](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
101+
**Please feel free to disable any plugin that you do not wish to have activated from the use of our extension pack. :)**
84102

85-
* [**markdownlint**](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
103+
## Visual Studio Code Tips and Tricks from its Docs
86104

87-
* [**Markdown TOC**](https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc)
105+
* Please puruse the [**Visual Studio Code Variables Reference**](https://code.visualstudio.com/docs/editor/variables-reference), if you wish to use **variables substitution**.
88106

89-
* [**Prettier - Code Formatter**](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
107+
* VSCode Keyword Shortcuts
90108

91-
* [**Run on Save**](https://marketplace.visualstudio.com/items?itemName=emeraldwalk.runonsave)
109+
* [**Linux**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf): Link contains **PDF**.
92110

93-
* [**YAML**](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
111+
* [**macOS**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf): Link contains **PDF**.
94112

95-
* [**WakaTime**](https://marketplace.visualstudio.com/items?itemName=WakaTime.vscode-wakatime)
113+
* [**Windows**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf): Link contains **PDF**.
114+
115+
* Please puruse the [**Visual Studio Code Keybindings**](https://code.visualstudio.com/docs/getstarted/keybindings), if you wish to use **custom keybindings**.
116+
117+
* [**Optional Keymap Extensions**](https://code.visualstudio.com/docs/getstarted/tips-and-tricks): I recommend the specific keybinding extension that meets your use case through Microsoft, if possible.
118+
119+
* Please puruse the [**Visual Studio Code Tips and Tricks**](https://code.visualstudio.com/docs/getstarted/tips-and-tricks) to make your experience a little bit more enjoyable.
96120

97121
## Note
98122

99-
It is my pledge to update this Extension Package with update extension as needed to perform the job efficiently and effectively. Likewise, the Extensions list will be categorized accordingly and more detailed information regarding plugins will be incorporated in the near future. Cheers! :)
123+
It is my pledge to update this Extension Package with update extension as needed to perform the job efficiently and effectively. Likewise, the Extensions list will be categorized accordingly and more detailed information regarding plugins will be incorporated in the near future. I will certainly be on the lookup for some helpful Python Development hints and tips to make your experience enjoyable. Cheers! :)
124+
125+
## Recommended Tutorials for Visual Studio Code
126+
127+
* [**Visual Studio Code Crash Course**](https://www.youtube.com/watch?v=WPqXP_kLzpo) (1:32:34): Courtesy of [**Mr. James Quick**](https://learn.jamesqquick.com/) from [**FreeCodeCamp.org**](https://www.freecodecamp.org/), whom provided a [**VS Code Cheatsheet**](https://learn.jamesqquick.com/vs-code-cheat-sheet) on his website (**note**: free registration required).
128+
129+
* [**Setting Up VSCode for Python Programming**](https://www.youtube.com/watch?v=W--_EOzdTHk) (22:19): Courtesy of the one and only Mr. Brad Traversy from [**Traversy Media**](https://www.traversymedia.com/).
130+
131+
## Recommended Tutorials on Python
132+
133+
### From Traversy Media
134+
135+
* [**Python Crash Course for Beginners**](https://www.youtube.com/watch?v=JJmcL1N2KQs) (1:35:36) [November 28, 2018]
136+
137+
* [**Pipenv Crash Course**](https://www.youtube.com/watch?v=6Qmnh5C4Pmo&list=PLillGF-RfqbbJYRaNqeUzAb7QY-IqBKRx&index=12) (15:39) [December 23, 2018]
138+
139+
* [**Python and MySQL Crash Course**](https://www.youtube.com/watch?v=BHwgnGEhYG8&list=PLillGF-RfqbbJYRaNqeUzAb7QY-IqBKRx&index=2) (24:38) [June 15, 2020]
140+
141+
* [**Object Oriented Programming (OOP) in Python**](https://www.youtube.com/watch?v=MikphENIrOo) (43:46) [August 21, 2020]
142+
143+
* [**Python Django Crash Course**](https://www.youtube.com/watch?v=e1IyzVyrLSU&list=PLillGF-RfqbbJYRaNqeUzAb7QY-IqBKRx&index=5) (1:11:50) [September 4, 2019]
144+
145+
### From FreeCodeCamp.org
146+
147+
* [**Learn Python - Full Course for Beginners**](https://www.youtube.com/watch?v=BHwgnGEhYG8&list=PLillGF-RfqbbJYRaNqeUzAb7QY-IqBKRx&index=2) (4:26:51) [July 11, 2018]
148+
149+
* [**Intermediate Python Programming Course**](https://www.youtube.com/watch?v=HGOBQPFzWKo) (5:55:46) [August 27, 2020]
150+
151+
**Please let me know if you know any other _FREE_ Python resources that might benefit others by creating a new issue in the [**Issues Section**](https://github.com/jillmnolan/python-essentials/issues).**
100152

101153
## Attributions
102154

103-
Thank you for all the developers that built these above referenced extensions. My genuine appreciaion for your hard work and dedication to the developer community. :)
155+
Thank you for all the developers that built these above referenced extensions. My genuine appreciation for your hard work and dedication to the developer community. :)
156+
157+
## Visual Studio Code Extension Packs
158+
159+
* [**COBOL Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.cobol-essentials): A Visual Studio Code extension for [**Mainframe**](https://www.ibm.com/it-infrastructure/z/education/what-is-a-mainframe) development, particularly [**Mainframe as a Service (MaaS)**](https://watech.wa.gov/sites/default/files/public/Mainframe%20MFaaS%20one%20pager_3-13-20.pdf#:~:text=mainframe%20service%20to%20a%20vendor-managed%20cloud%20solution.%20Definition.,the%20IT%20infrastructure%2C%20support%20and%20maintenance.%20Customers%20pay). Link contains PDF from [**Washington Technology Services**](https://watech.wa.gov/), which provides an example of MaaS.
160+
161+
* [**Java Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.java-essentials): A Visual Studio Code extension pack for Java development.
162+
163+
* [**.NET Core Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.dotnet-core-essentials): A Visual Studio Code extension pack for .NET Core development, with special provisions for Azure Cloud development through official Microsoft extensions.
164+
165+
* [**PHP Development Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.php-development-essentials): A Visual Studio Code extension pack that serves as the comprehensive version of Web Development Essentials pack, which, unlike Web Development Essentials, does not have Angular or React extensions.
166+
167+
* [**Python Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.python-essentials): This Visual Studio Code Extension Pack is what you are currently seeing. :)
104168

105-
## Published Extensions Packs in VSCode Marketplace
169+
* [**Web Development Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.web-development-essentials-pack): A Visual Studio Code extension pack that serves as the condensed version of the PHP Development Essentials pack for Visual Studio Code, whose main premise is centered around JavaScript ecosystem.
106170

107-
* [**.NET Core Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.dotnet-core-essentials)
171+
## Disclaimer
108172

109-
* [**Python Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.python-essentials)
173+
**Please be advised that this is an "off-the-clock" passion project, whose intent is to be utilized by anyone (including my colleagues) who will derive benefit from this one-click installation of popular extensions that I felt was a relevant theme to this Extension Pack.**
110174

111-
* [**Web Dev Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.web-dev-essentials)
175+
## Signing Off
112176

113177
**Please enjoy! Cheers!**

0 commit comments

Comments
 (0)