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)
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

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.0.1.tar.gz (3.2 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.0.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: word_vba-0.0.1.tar.gz
  • Upload date:
  • Size: 3.2 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.0.1.tar.gz
Algorithm Hash digest
SHA256 8189e33035e8a65d9f62fc5f4834a0ac9b10f85e901029f1fc20bc0432ab156d
MD5 7e97a6135193d2336d5a1cf44455fc80
BLAKE2b-256 0306c0ed5f5009f7b558b9fd6b989cf8b2534a0e3268d946f4192f9e6f10caef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: word_vba-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 478ee9ad3f25a921c773b3e546be2ed40b1e29664269bfc6b3280778d532f544
MD5 a2b85b95c09e978b3b82564aaa2bf9e1
BLAKE2b-256 85bed34cc2fa27a87e48655d627bc9ba5200839eff50bb535b71b0f7432cf929

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