Skip to main content

Create VSCode Extensions with python

Project description

vscode.py logo

Maintenance Downloads PyPI version Code style: black

About

Create vscode extensions with python.

Installation

Stable version:

pip install vscode.py

Why use vscode.py?

Why should you use this for building VScode extensions when you can use typescript? Here are some reasons:

  • vscode.py builds the package.json for you! No need to switch between your extension.py and package.json in order to add commands. It also handles adding Activity Bars, Keybinds and Views.
  • vscode.py provides a pythonic way of creating the extension. Python has some powerful modules that Javascript doesn't and you can include these with vscode.py
  • vscode.py extensions work perfectly with vsce and you can publish your extensions just like you would publish any other extension.

Example Extension

import vscode
from vscode import InfoMessage

ext = vscode.Extension(name="Test Extension")

@ext.event
async def on_activate():
    vscode.log(f"The Extension '{ext.name}' has started")


@ext.command()
async def hello_world(ctx):
    return await ctx.show(InfoMessage(f"Hello World from {ext.name}"))

ext.run()

Tutorial

Step 1

Create a python file inside a folder.

image

Step 2

Write the code for your extension. For this tutorial we have used the Example Extension

Step 3

Run the python file. It will build the required extension files.

image image

Step 4

Press F5. This will run the extension and open a new vscode window in development mode.

Step 5

Finally, test your command.

  • Open the command palette with Ctrl+P in the development window.

image

  • Type >Hello World

image

  • It should show a popup like this in the bottom right corner

image

Extensions built using vscode.py

Here's a list of some extensions built using vscode.py. If you'd like to include your extension here feel free to create a PR.

Documentation

The docs are coming soon! In the meantime you can look at the examples in order to learn how vscode.py works and what it offers!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vscode_py2-2.0.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vscode.py2-2.0.1-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file vscode_py2-2.0.1.tar.gz.

File metadata

  • Download URL: vscode_py2-2.0.1.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for vscode_py2-2.0.1.tar.gz
Algorithm Hash digest
SHA256 1be666033b0db4303bed71bbb813655a7f17b286779cbe84250d407644f53fe0
MD5 1070a7a87d0d60e9258782a8001c55bb
BLAKE2b-256 661241f019fcd614ba520cf6de11de4ae5de6b4b8baf280a0ed857e90720d543

See more details on using hashes here.

File details

Details for the file vscode.py2-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: vscode.py2-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for vscode.py2-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ccdb2330ce02403f8e6f2b8e513adb3d2100091210d8bbe1c1ef908f18451599
MD5 6a48bf34c1393578a8820efa2caec1cb
BLAKE2b-256 447871beabc7221c3174142fd2e9e55be2c4e38e027f5b6477f0df278a928969

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page