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

word-vba downloads

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)   | 
|                  |                            |                  |     optional
|                  |                            |  [.toml]         |  <- support for 
|                  |                            |                  |     references
+------------------+                            +------------------+
                                                         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 references list List VBA library references
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.5.0.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.5.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: word_vba-0.5.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for word_vba-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d342e1dbfd2ecb195a2d6640faf22de868ebb99e0e3f27950001257839a7c1ae
MD5 803785f32951a9b44ea67f25b7b12de5
BLAKE2b-256 7626e97ab05311961a3de39e4b58c3c39f239b9857274abdef0139354b459389

See more details on using hashes here.

Provenance

The following attestation bundles were made for word_vba-0.5.0.tar.gz:

Publisher: publish.yaml on markuskiller/vba-edit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: word_vba-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for word_vba-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40057e63162d1221269a5281c42b4e5ab44645933affa56ca7d51e0d7679a84e
MD5 9731c53cc551c75dc8ab6b6fd8f77f0b
BLAKE2b-256 9545bf68e5848002ef1bdbbee1431285f8bbb328cc5689f4a4a46e4c970d4622

See more details on using hashes here.

Provenance

The following attestation bundles were made for word_vba-0.5.0-py3-none-any.whl:

Publisher: publish.yaml on markuskiller/vba-edit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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