gbdxtools Documentation

CHAPTER 1
Getting started
1.1 Getting access to GBDX
All operations on GBDX require credentials. Instantiating an Interface object automatically logs you in:
>>> from gbdxtools import Interface
>>> gbdx = Interface()
gbdxtools expects a config file to exist at ~/.gbdx-config with your GBDX credentials. See formatting for this
file here: https://github.com/tdg-platform/gbdx-auth#ini-file. To get a GBDX username, password and API key,
please email geobigdata@digitalglobe.com. For future reference, remember that your credentials are listed in
https://gbdx.geobigdata.io/account/user/settings/.
1.2 Getting your S3 information
Use the s3 member of the Interface:
>>> gbdx.s3.info
>>> {u'S3_access_key': u'blah',
u'S3_secret_key': u'blah',
u'S3_session_token': u'blah',
u'bucket': u'gbd-customer-data',
u'prefix': u'58600248-2927-4523-b44b-5fec3d278c09'}
>>> item = 'testdata/test1.tif'
>>> gbdx.s3.download(item)
You can see the contents of your bucket/prefix using this link: http://s3browser-env.elasticbeanstalk.com/login.html.
1.3 Ordering imagery
This guide uses v2 of the GBDX ordering API. Ordering API v1 was deprecated on 02/25/2016.
Use the ordering member of the Interface to order and status imagery.
To order the image with DG factory catalog id 10400100143FC900:
>>> order_id = gbdx.ordering.order('10400100143FC900')
>>> print order_id
04aa8df5-8ac8-4b86-8b58-aa55d7353987
3