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.py-2.0.0b2.tar.gz (18.8 kB view details)

Uploaded Source

File details

Details for the file vscode.py-2.0.0b2.tar.gz.

File metadata

  • Download URL: vscode.py-2.0.0b2.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for vscode.py-2.0.0b2.tar.gz
Algorithm Hash digest
SHA256 a4dc690ecd66c0abaa0c5f10d1943c233bc80a3257211490754267fd0dc041b0
MD5 72b6fb9bfdfe5e6de26f6550c03567d5
BLAKE2b-256 366a306cc1f3aa8207ab1c4ed8f339b3dedb841339f69b7e0665436e931396ca

See more details on using hashes here.

Provenance

Supported by

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