Quickbase API Python Wrapper


Keywords
quickbase
License
EPL-1.0
Install
pip install pyqb==0.2.5

Documentation

pyqb

A python library for the Quickbase API. For more information about the Quickbase API, please see http://www.quickbase.com/api-guide/index.html

Requirements

  • python 2.6+
  • xmltodict
  • requests

Installation

$ pip install pyqb

Usage

Create the client

import pyqb
# def Client(url="http://www.quickbase.com", database=None, proxy=None, user_token=None):
qbc = pyqb.Client(url='http://my_domain.quickbase.com')
# Below authenticate is not required if `user_token` argument is passed to pyqb.Client() above
qbc.authenticate(username='myusername', password='mypassword')

DoQuery

# doquery(query=None, qid=None, qname=None, database=None, fields=None, fmt=False, rids=False, sort_fields=None, options=False):
qbc.doquery(qid=64)
qbc.doquery(query='{"6".EX."myval"}', database='asdfasdf')
qbc.doquery(qid=64, fields=["3", "4"], fmt=True, rids=False)

EditRecord

# editrecord(rid=None, database=None, fields=None, update_id=None)
f = { "6": "newvalue" }
res = qbc.editrecord(rid='18081', database='asdfasdf', fields=f)

AddRecord

# def addrecord(database=None, fields=None)
f = { "hostname": "myhost", "7": "1.2.3.4" }
res = qbc.addrecord(database='asdfasdf', fields=f)

DeleteRecord

# deleterecord(rid=None, database=None)
res = qbc.deleterecord(rid='18081', database='asdfasdf')

API Support

  • DoQuery
  • EditRecord
  • GetNumRecords
  • AddField
  • DeleteRecord

Authors