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.3.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.3-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: word_vba-0.4.3.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for word_vba-0.4.3.tar.gz
Algorithm Hash digest
SHA256 3e3d16001b8384232df3b2bb31b3aac03ab761e7b2ee0a027c50bc0575f5fae0
MD5 51c146bbc8f2d00b23bfd75fd7ce039b
BLAKE2b-256 bebcb71b90b89212e1f83f6b43e8bfb86524d0d10bc489b79025e75244bc606f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: word_vba-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for word_vba-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dc1968311585504f9bf7637fad6eec71bc28075f3e269d44c8bbdfad9ccf121a
MD5 e393cabae5afb81c1d8e350899dfbce9
BLAKE2b-256 c196247c6ac2fd6d490a34cb05638fd39b7ed239f7ae8adf4d742aa772e6ac6e

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