/gbdxtools

Python tools to order imagery and launch workflows on DigitalGlobe's GBDX platform.

Primary LanguagePython

gbdxtools: Python tools for using GBDX

gbdxtools is a package for ordering imagery and launching workflows on DigitalGlobe's GBDX platform.

gbdxtools is MIT licenced.

Installation is easy:

pip install gbdxtools

If you have a previous version of gbdxtools install then:

pip install --upgrade gbdxtools

In order to use gbdxtools, you need GBDX credentials. Email geobigdata@digitalglobe.com to get these.

Documentation is hosted here: http://gbdxtools.readthedocs.org/en/latest/. Example scripts can be found under the /examples directory of this repo.

Development

Clone the repo dev branch:

git clone -b dev git@github.com:kostasthebarbarian/gbdxtools.git

cd gbdxtools

Start a virtual environment:

virtualenv venv

. venv/bin/activate

Install the requirements:

pip install -r requirements.txt

Please follow this python style guide: https://google.github.io/styleguide/pyguide.html. 80-90 columns is fine.

Tests

This package uses pytest http://pytest.org/latest/contents.html.

pytest allows for tests to be written using various frameworks, so unittest.TestCase, pytest, and nose style tests will be detected and run.

To run all of the tests:

py.test tests

If you want only the unit or integration tests do either of:

py.test tests/integration
py.test tests/unit

Note: you may have to issue the following in your virtualenv for the tests to find gbdxtools properly:

pip install -e .