Local development

It’s often useful to be able to run and debug a Gridarrow App locally on your own machine. In this tutorial you’ll learn how to set up a development environment and execute an App locally.

Prerequisites

Python

Gridarrow Apps use Python 3.6. If you don’t already have this version of Python installed you should download and install the latest version from the official website. It’s normally best to accept the installer defaults. We also recommend to check the Add Python 3.6 to PATH checkbox.

The Hitchhiker’s Guide to Python has some good documentation on how to install Python on windows (and is also a great read generally).

Gridarrow Python library

Although it’s outside the scope of this documentation, We do recommend using a virtualenv for any Python work as it keeps your application dependencies isolated and therefore more stable.

With Python 3.6 installed, run the pip install gridarrow command to install the Gridarrow Python library.

Running an App locally

To run the App locally, cd into your App’s directory and type gridarrow run app.py. You should see something like the messages below:

2018-02-15 11:10:06,604|MainThread|INFO|gridarrow.server|Starting server [::]:50051                                     
2018-02-15 11:10:06,620|MainThread|INFO|gridarrow.server|Starting application <Arrow.app>                               
2018-02-15 11:10:06,620|MainThread|DEBUG|gridarrow.arrow|Starting interval functions                                    
2018-02-15 11:10:06,620|Thread-2|DEBUG|urllib3.connectionpool|Starting new HTTP connection (1): demo.gridarrow.io
....

You can stop the App by pressing CTRL+C

Connecting to a local App

Now, in your Excel Add-in, you should see a section with the heading Developer. Click on the + icon next to it to configure at which port the development app is running. Leave the default port number and click OK.

You can change the port on which your App is running by passing --port flag to the gridarrow run command

A new entry will appear in the Developer section, and clicking the toggle button will connect to your App.

Once connected, click on Add to new sheet button next the grid name to automatically add it to a new spreadsheet.

Connecting to locally running Gridarrow App from Excel

What’s next