Grist api client for nim-lang

Over the last few weeks, i build an rest api client for Grist in the Nim programming language.

Its does not cover all the features that grist exposes via its api.
But i already use it in some of my projects.

For example its the driver of my grist download tool.

If you do not know Nim, check it out, it’s a compiled, elegant and type safe programming language,
and kind of an inside tip. It produces small and easy to distribute binary executables.

Here are some usage examples:

import gristapi, json, times, strformat

# Create a new grist api client object.
var grist = newGristApi(
  docId = "<myDocId>",
  apiKey = "<myApiKey>",
  server = ""

# `%*` is used to convert data to json in Nim.
# Here we fetch 3 items from the `TODO` table which are not done yet, sorted by the "Added" column
for row in grist.fetchTable("TODO", %* {"Done": [false]}, limit = 3, sort = "Added"):
  echo row["id"] # the id of the row
  echo row["fields"] # all the fields of the row

# Add some records to the `TODO` table
echo grist.addRecords("TODO", @[
    %* {"Task": "PETER", "Details": "DETAILS!!!"},
    %* {"Task": "PETER2", "Details": "DETAILS!!!2", "Deadline": "HAHA"}

grist.modifyRecords("TODO", @[
    ModRecord(id: 4, fields: %* {"Task": "ASD"}),
    ModRecord(id: 5, fields: %* {"Task": "BBBB", "Details": "DET"}),
    ModRecord(id: 6, fields: %* {"Task": "BBBB", "Details": "DET", "Deadline": "2022.01.13"}),

# Delete some records from the table `TODO`
grist.deleteRecords("TODO", [1,2,3])

# Download the document
let dateStr = $now() # `$` converts to a string in Nim

# `fmt` is one of Nim's string interpolation libraries.
# It is provided by the `strformat` imports above.
let dataSqlite = grist.downloadSQLITE()
writeFile(fmt"gene__{dateStr}.sqlite", dataSqlite)

let dataXLSX = grist.downloadXLSX()
writeFile(fmt"gene__{dateStr}.xlsx", dataXLSX)

let dataCSV = grist.downloadCSV("Entries")
writeFile(fmt"geneEntries__{dateStr}.csv", dataCSV)


I’ve added attachment procs to the api client.
Now you can also upload/download attachment with the api client!

# Attachments
# Upload an attachment
# Attachments must be first uploaded to the grist document THEN they must be referenced
let id = grist.uploadAttachment("someFile.png")

# Reference attachment in a cell
# Use `cellAttachment(id)` or manually via `%* ["L", id]`
echo grist.addRecords("Table1", @[%* {"A": "AAA", "B": "BBB", "uploads": cellAttachment(id)}])

# Upload and reference in one step
echo grist.addRecords("Table1", @[%* {"A": "AAA", "B": "BBB", "uploads": cellAttachment(grist.uploadAttachment("someFile.png"))}])

# Get attachments metadata
echo grist.attachmentsMetadata(id)

# List all attachments
for metadata in grist.attachmentsMetadata():
  echo metadata

for metadata in grist.attachmentsMetadata(limit = 10):
  echo metadata

for file in grist.attachmentsMetadata(filter = %* {"fileName":["someFile.png"]}):
  echo file

# Download one attachment
echo grist.attachmentsDownload(id) # print the content of "someFile.png"
echo grist.attachmentsSaveSmart(id, "/tmp/") # saves the attachment to the folder "/tmp/" under its original name

# Download all attachments
grist.attachmentsSaveAllSmart("/tmp/") # saves all attachments 
1 Like

i’ve added webhook procs to the api client.
Now you can get, create and delete webhooks with the api client.

## Webhooks

# List all webhooks
echo grist.webhooksGet()

# Remove all webhooks

# Create a webhook
# we need to use a `WebhookConfig` for this
var wh = WebhookConfig() = "abc"
wh.memo = "foo baa baz"
wh.url = ""
wh.enabled = true
wh.eventTypes = @[WHadd, WHupdate]
wh.isReadyColumn = ""
wh.tableId = "Todo"
let id = grist.webhookCreate(wh) # returns the id of the webhook
echo "Created: ", id

# We can use the id to modify the webhook = "abc update"
grist.webhookModify(id, wh)

# And also to remove the webhook
echo grist.webhookRemove(id)