Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a section mentioning npm module for Python API #6514

Merged
merged 1 commit into from
Jul 20, 2023
Merged

Add a section mentioning npm module for Python API #6514

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions api/advanced-topics/python-extension-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@ ContentId: dd7207b0-cf8b-4ed6-8c75-941834179dca
DateApproved: 9/28/2022

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Using the Python extension template to integrate linters, formatters, and language features into Visual Studio Code
MetaDescription: Using the Python extension template and API to integrate linters, formatters, and language features into Visual Studio Code
---
# Python Extension Template

The [Python extension template](https://github.com/microsoft/vscode-python-tools-extension-template) helps get you started building a Visual Studio Code extension for your favorite Python tool. It could be a linter, formatter, or code analysis, or all of those together. The template will give you the basic building blocks you need to build an extension that integrates your tool into VS Code.
# Authoring Python Extensions

>**Note**: If you are new to VS Code extension authoring, you may want to read the [Your First Extension](/api/get-started/your-first-extension) tutorial first and try creating a simple Hello World extension.

The [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) provides APIs for other extensions to work with Python environments available in the user's machine. Check out [`@vscode/python-extension`](https://www.npmjs.com/package/@vscode/python-extension) npm module which carries types and helper utilities to access this feature for your extension.

# Python Extension Template

The [Python extension template](https://github.com/microsoft/vscode-python-tools-extension-template) helps get you started building a Visual Studio Code extension for your favorite Python tool. It could be a linter, formatter, or code analysis, or all of those together. The template will give you the basic building blocks you need to build an extension that integrates your tool into VS Code, and it already has access to Python API feature mentioned above.

## Programming languages and frameworks

The extension template has two parts, the extension part and language server part. The extension part is written in TypeScript, and language server part is written in Python over the `pygls` (Python language server) library.
Expand Down