pyQuickBase: Python Interface to QuickBase API

pyQuickBase is an MIT licensed client library for the Intuit QuickBase API, using Requests for HTTP, and lxml is used for XML processing.

Version

0.2.4

• Fixed _parse_records to check for <url> child in structured record fields (for file downloading).

0.2.3

• Added a new return_file function to retrieve a QuickBase file as a Python file object.

0.2.2

• Fixed a readme issue.

0.2.1

• Made the package pip installable.
• Added support for uploading files with add_record module.

Installation

To install pyQuickBase, simply:

$ pip install pyquickbase

API Features

• add_record
• add_replace_db_page
• delete_record
• do_query
• do_query_count
• edit_record
• get_db_page
• get_schema
• granted_dbs
• import_from_csv
• list_db_pages

Other Modules

• get_file -- used in conjunction with a query and specified attachment field ID, can download one or many files from a table to local folder.

Requirements

• Python (2.6+)
• lxml
• Requests
• chardet
• cStringIO

Examples

Initialize the client:

>>> import quickbase
>>> client = quickbase.Client(username, password, database=database,
        apptoken=token, base_url=url)
...

List all records in a table:

>>> import datetime
>>> response = client.do_query(query="'3'.XEX.''}", structured=True,
        columns='a', database=database)
>>> for record in response:
        dt = datetime.datetime.fromtimestamp(int(r['1']) / 1000).strftime('%m-%d-%Y')
        print "Record ID# %s was created on %s" % (record['3'], dt)
...

License

MIT, See license file.

Developed by Kevin V Seelbach. You may email me directly if you have questions or need help.

Contribute

1. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
2. Write a test which shows that the bug was fixed or that the feature works as expected.