Metadata-Version: 1.1
Name: pyquickbase
Version: 0.2.4
Summary: pyQuickBase is a Python interface for the Intuit QuickBase API
Home-page: http://kevinseelbach.github.io/pyQuickBase/
Author: Kevin V Seelbach
Author-email: kevin.seelbach@gmail.com
License: UNKNOWN
Description: 
        pyQuickBase: Python Interface to QuickBase API
        ==================================================
        
        .. image:: https://badge.fury.io/py/pyquickbase.png
            :target: http://badge.fury.io/py/pyquickbase
        
        
        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:
        
        .. code-block:: bash
        
            $ 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:
        
        .. code-block:: pycon
        
            >>> import quickbase
            >>> client = quickbase.Client(username, password, database=database,
                    apptoken=token, base_url=url)
            ...
        
        List all records in a table:
        
        .. code-block:: pycon
        
            >>> 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 <http://www.kevinseelbach.com>`_. You may `email me directly`_ if you have questions or need help.
        
        
        Contribute
        ----------
        #. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it).
        #. Write a test which shows that the bug was fixed or that the feature works as expected.
        
        
        
        .. _`the repository`: http://github.com/kevinseelbach/pyQuickBase
        .. _lxml: http://lxml.de/
        .. _Requests: http://docs.python-requests.org/en/latest/
        .. _email me directly: kevin.seelbach@gmail.com
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Environment :: Web Environment
