Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.4 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.4 KB
Raw

What is cartodb-python?

The cartodb-python project is a Python client for the CartoDB SQL API that supports authentication using OAuth.

Installation

You can install cartodb-python by cloning this repository or by using Pip, a Python package installer similar to easy_install.

pip install cartodb

or if you want to use the development version

pip install -e git+git://github.com/javisantana/cartodb-python.git#egg=cartodb

Note that cartodb-python depends on the ouath2 module

pip install oauth2

and if you're running python < 2.6 you need to install simplejson

pip install simplejson

Usage example

The following example requires your CartoDB API consmer key and consumer secret. Refer to the CartoDB Authentication documentation for details.

from cartodb import CartoDB, CartoDBException

user =  'me@mail.com'
password =  'secret'
CONSUMER_KEY='YOUR_CARTODB_CONSUMER_KEY'
CONSUMER_SECRET='YOUR_CARTODB_CONSUMER_SECRET'
cartodb_domain = 'YOUR_CARTODB_DOMAIN'
cl = CartoDB(CONSUMER_KEY, CONSUMER_SECRET, user, password, cartodb_domain)
try:
    print cl.sql('select * from mytable')
except CartoDBException as e:
    print ("some error ocurred", e)