Skip to main content

Reading & Math Inc Python SDK for Quick Base

Project description

Quickbase-Python-SDK

#RMI Usage Notes -Should not be used on a standalone basis. Instead, integrate a release into the API or project that it is required for, using pipenv or other package manager.

Python bindings for the QuickBase API

QBConn variables:

error: the numerical error code returned by an API call. 0 is no error, negative values are internal to this library
tables: a dictionary containing tablename:tableID pairs

[constructor] QBConn(QB_URL,QB_APPID, USER_TOKEN):

Makes a connection to the QuickBase specified by QB_URL and QB_APPID. As of 0.4.0, *requires* a USER_TOKEN; will not authenticate with a ticket
Note: QB_URL should have a trailing slash. ex. "https://intuitcorp.quickbase.com/db/";

provide_tables: exposes tables to public api

sql(querystr): Performs a query() after translating a simple SQL-style string to QuickBase's query format

Example: qb.sql("SELECT * FROM users WHERE name`EX`John\_Doe OR role`EX`fakeperson") #The \_ represents a space. This is a very basic function that doesn't use state machines. Note: field and table names will not have spaces
Example: qb.sql("SELECT firstname|lastname FROM users WHERE paid`EX`true ORDER BY lastname ASC LIMIT 100")
Example: qb.sql("DELETE FROM assets WHERE value`BF`0")
Please contribute any improvents you make on this function back to this repo. It would make life so much easier for all QuickBase+Python users :)

request(params,url_ext):

Takes a dict of param:value pairs, adds ticket, token, and realm (if specified) and makes an API call to the base URL+url_extension

getFields(tableID):

Returns a dict containing the fields of a table as fieldname:fieldID pairs

addRecord(tableID,data):

Adds a record with data specified by the data dict of fieldname:value pairs to tableID

editRecord(tableID,rid,newdata[,options]):

Updates a record (rid) in table (tableID) with the data given by newdata fieldname:value pairs

deleteRecord(tableID,rid):

Deletes record specified by rid from table specified by tableID

purgeRecords(tableID,query):

Deletes records from tableID that match the QuickBase-style query

_getTables():

Returns a dict containing a QuickBase app's tables as tablename:tableID pairs. This is run automatically after a successful authenticate call

query(tableID,query):

Returns a list of dicts containing fieldname:value pairs that represent rows returned by the query. record ID will always be specified by the "rid" key

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rmi_qb_sdk-0.4.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

rmi_qb_sdk-0.4.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file rmi_qb_sdk-0.4.1.tar.gz.

File metadata

  • Download URL: rmi_qb_sdk-0.4.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.4.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.5

File hashes

Hashes for rmi_qb_sdk-0.4.1.tar.gz
Algorithm Hash digest
SHA256 05832957f171a7b95be45b3ec97b1b687fb75616eee7caeefbaabd9200c3a131
MD5 3949ba8a0752ccddd662e63e072d28ec
BLAKE2b-256 ef4b284e7d610aea96d41a02d37bbbf496806acb867fa79b92e66ea4a5f3bf65

See more details on using hashes here.

File details

Details for the file rmi_qb_sdk-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: rmi_qb_sdk-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.4.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.5

File hashes

Hashes for rmi_qb_sdk-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 99625abd224bd39972330c86705c5e3c11351bde74b6f17809a633e84861ea7f
MD5 51b02e126996fcec2db3bc396bbc33b0
BLAKE2b-256 8639b51c6d2409927c6319d93249ebfba7d0f9e311a3593caf925c5f7709e614

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page