Local Development

Prerequisites

• Follow Git Repository Setup.

• If you want to use Office.js add-ins, you need to first create development certificates. If you will be using VBA, Office Scripts, or Google Apps Script, you can skip this.

Running the development server

1. In a Terminal/Command Prompt, with the correct Python environment activated, run:

   python run.py
   

   You should see something like this:

   INFO:     Will watch for changes in these directories: ['/Users/username/dev/xlwings-server']
   INFO:     Uvicorn running on https://127.0.0.1:8000 (Press CTRL+C to quit)
   INFO:     Started reloader process [68315] using WatchFiles
   INFO:     Started server process [68317]
   INFO:     Waiting for application startup.
   INFO:     Application startup complete.
   

2. Open https://127.0.0.1:8000 in a browser (use http:// instead of https:// if you didn’t create the development certficates). You should see {"status": "ok"}.

3. If you are using the Office Scripts or Google Apps Script integrations, set up Tunneling. If you are using Office.js add-ins or the VBA integrations, you can skip this step.