Skip to main content

Edit, export and import Word VBA code from the command line. Thin entry-point wrapper for vba-edit.

Project description

word-vba belongs to vba-edit CLI Tools

Edit VBA code in VS Code, PyCharm, Wing IDE, or any editor you love. Real-time sync with MS WORD. Git-friendly. No more VBA editor pain.

CI PyPI - Version PyPI - Python Version Platform vba-edit - Downloads word-vba - Downloads License

This is a thin entry-point package for vba-edit. Installing word-vba gives you the word-vba command and automatically installs the vba-edit core package.

Quick Start

RECOMMENDED: Via uvx

uvx word-vba edit -f myfile.docm --vba-directory .\src\VBA

Note: The uvx command invokes a tool without installing it — same as: uv tool run word-vba

30-Second Demo

# Start editing (uses active Word document)
uvx word-vba edit

# That's it! Edit the .bas/.cls files in your editor. Save = Sync.

How It Works

                        <--- vba-edit --->

    MS WORD                  COMMANDS              Your favourite
                                v                       Editor

+------------------+                            +------------------+
|                  |                            |                  |
|   VBA Project    |   <---   EDIT*   (once ->) |  (e.g. VS CODE)  | 
|                  |                            |                  |     latest
|  (Office VBA-    |          EXPORT      --->  |   .bas           |  <- AI coding-  
|    Editor)       |                            |   .cls           |     assistants
|                  |   <---   IMPORT            |   .frm           |   
|                  |                            |  (.frx binary)   | 
|                  |                            |                  | 
+------------------+                            +------------------+
                                                         v
                                                +------------------+
                                                |                  |
 * watches & syncs                              |    (e.g. Git)    |
   back to Office                               |  version control |
   VBA-Editor live                              |                  |
   on save [CTRL+S]                             |                  |
                                                +------------------+

Install

pip install word-vba

Note: Installing word-vba also installs the vba-edit core package, which provides entry points for all supported Office apps (excel-vba, word-vba, powerpoint-vba, access-vba).

Usage

All commands below work with both word-vba <command> (installed) and uvx word-vba <command> (no install required).

Command What it does
word-vba edit Start live editing
word-vba export One-time export
word-vba import One-time import
word-vba export --open-folder --keep-open Export and open folder in explorer, keep document open for inspection
word-vba export --force-overwrite Export without confirmation prompts
word-vba check Verify status of Trust access to the VBA project object model

💡 Complete Option Matrix: available here

For full documentation see github.com/markuskiller/vba-edit.

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

word_vba-0.4.4.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

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

word_vba-0.4.4-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file word_vba-0.4.4.tar.gz.

File metadata

  • Download URL: word_vba-0.4.4.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for word_vba-0.4.4.tar.gz
Algorithm Hash digest
SHA256 e8e9d73544a78a3fb84abfa5ee3e7e8deec871ff5e64803d66506a59e63b0ba0
MD5 d2fced98e801a764c1d352689f299922
BLAKE2b-256 d6d785a8f176f4e884949d7936d2019df3858581b167104b070f6a1d390454b5

See more details on using hashes here.

File details

Details for the file word_vba-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: word_vba-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for word_vba-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fefc9c06dceb8fb8c4888ba2b2804d29b4a26367263e49d30489f14187e72ba0
MD5 625247f0d0b17601a15098ea64672336
BLAKE2b-256 d95f8a40afc63165cedd19a6cfc2b4f9074a7c7e32c8fd97d09651812a8b236e

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