pyvscodeextroh 0.0.1

A python package to manage vscode extensions.

pyvscodeextroh

The pyvscodeextroh package can be used to manage VSCode extensions via policy file, remotely or via MDM solution.

Table of Contents

1. Introduction
2. Getting started
   1. Prerequisites
   2. Installation
3. How to use
   1. How to import
   2. Using the module
4. Releasing
5. License

Introduction

While software, driver, hardware and everything else is managed by organizations, most of them, are not managing their dev environments at all.

With emerging threads in dev environments and software supply chain, managing dev environments is and will be crucial for organizations in the future.

This python package aims to centralize the extension management on linux dev environments for VSCode via remote connections or MDM solutions like Ansible.

You can find an overview of all policies here.

Getting started

Prerequisites

• Python installed
• Operatingsystem: Linux or Windows, not tested on mac
• IDE like VS Code, if you want to contribute or change the code

Installation

There are two ways to install this module depending on the way you work and the preinstalled modules:

1. pip install pyvscodeextroh
2. python -m pip install pyvscodeextroh

How to use

How to import

You can import the module in two ways:

import pyvscodeextroh

This will import all functions. Even the ones that are not supposed to be used (helper functions).

from pyvscodeextroh import *

This will import only the significant functions, meant for using.

Using the module

You can do the following things:

• Add/Remove extensions to policy file
• Add/Remove publishers to policy file
• Deny extensions/publishers via policy file
• Install/Uninstall specific extensions
• Enforce the current policy file

Every command requires sudo priviliges.

The following examples show how to use this package and its modules in a script.

Example 1: Add a publisher to the policy

With this code only extensions from MS can be installed on the current machine.

# Add a publisher
from pyvscodeextroh.policy_editor import PolicyEditor
# Create an editor
editor = PolicyEditor()
# Allow all extensions from the publisher "microsoft"
editor.allow_publisher("microsoft")

# Result:
# Creates the file /etc/vscode/policy.json if it does not exist
# Appends follwing lines
# "AllowedExtensions": {
#    "microsoft": true
# }

Example 2: Enforce VSCode policy

This will enforce a policy from the /etc/vscode/policy.json. It force uninstalls all unallowed extensions.

from pyvscodeextroh import VSCodePolicyManager
# Use the default system policy file (/etc/vscode/policy.json)
pm = VSCodePolicyManager()
# Uninstall all unallowed extensions
pm.enforce_policy()

You can also use a custom policy file, if you want extensions managed seperated from other configurations like MCP, AI, ... .

A custom policy file has to look like:

{
    "AllowedExtensions": {
        "microsoft": true,
        "github": true,
        "ms-python.python": true,
        "evilcorp": false,
        "evilcorp.malware": false
    }
}

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Create release variable.
$Release = "x.x.x"
# Create commit.
git commit --allow-empty -m "Release $Release"
# Create tag.
git tag -a $Release -m "Version $Release"
# Push from original.
git push origin --tags
# Push from fork.
git push upstream --tags

License

MIT