README.md

Neptyne

Welcome to Neptyne, the Python based spreadsheet. Here's how to get up and running quickly.

Method 1: Use docker

The easiest way to get started is to use the docker image. This will give you a fully functional Neptyne environment with all the bells and whistles.

docker compose up -d
docker logs neptyne-spreadsheet-neptyne-1

The second statement will print out the shared secret you need to connect to the Neptyne server. Open that url and you are in business.

### Method 2: pip install

In a clean Python 3.11 environment, run:

```shell
pip install neptyne

After which you can start neptyne with:

python -m neptyne

Method 3: From source

You know the drill. Clone the repo, and run:

pip install -r requirements.txt

After which you can start neptyne with:

PYTHONPATH=. python server/application.py

Using Neptyne with Google Sheets

Neptyne works as a standalone spreadsheet but can also be used in conjunction with Google Sheets. To make this work, you'll need to first install the Neptyne GSheets Add-on. You can find it here.

After installing, open the configure server menu and enter the shared secret that Neptyne prints when it starts up. This will allow the GSheets Add-on to communicate with your Neptyne instance. You also need to enter a publicly accessible URL for your Neptyne instance. If you don't have a public URL, you can use a service like ngrok to create one.

Authorizing GSheets

To talk to GSheets through the Python REPL, either use a service account credential file or an OAuth client config. For service accounts, make sure the sheet is shared with the account, and add the credential file to ~/.config/neptyne/service_account.json. For OAuth, add the credential file to ~/.config/neptyne/oauth_credentials.json.