Command Line Client¶
xlwings comes with a command line client that makes it easy to set up workbooks and install the add-in.
On Windows, type the commands into a Command Prompt
, on Mac, type them into a Terminal
.
Quickstart¶
xlwings quickstart myproject
This command is by far the fastest way to get off the ground: It creates a new folder myproject
with an
Excel workbook that already has the reference to the xlwings addin and a Python file, ready to be used right away:
myproject
|--myproject.xlsm
|--myproject.py
If you want to use xlwings via VBA module instead of addin, use the --standalone
or -s
flag:
xlwings quickstart myproject --standalone
Add-in¶
The addin command makes it easy to install/remove the addin by copying it to the XLSTART
folder.
Note
Excel needs to be closed before installing/updating the add-in via command line. If you’re still getting an error,
start the Task Manager and make sure there are no EXCEL.EXE
processes left.
xlwings addin install
: Copies the xlwings add-in to the XLSTART folderxlwings addin update
: Replaces the current add-in with the latest onexlwings addin remove
: Removes the add-in from the XLSTART folderxlwings addin status
: Shows if the add-in is installed together with the installation path
After installing the add-in, it will be available as xlwings tab on the Excel Ribbon.
New in version 0.6.0.
RunPython¶
Only required if you are on Mac and haven’t run xlwings addin install
:
xlwings runpython install
Alternatively, install xlwings with pip
.
New in version 0.7.0.
Config¶
Creates the user config file with the correct settings for your Python installation from where you are running it.
This is automatically run when you install the add-in via xlwings addin install
.
xlwings config create [--force]
-f/--force
will overwrite existing config files.
New in version 0.19.5.