Skip to main content

Python package to make it easy to use Isogeo REST API

Project description

PyPI version Travis build status Codecov - Coverage status Documentation Status Python 2.7.x compatiblity Python 3.4.x compatiblity Python 3.5.x compatiblity Python 3.6.x compatiblity

Isogeo API Python SDK

A Python package to use Isogeo REST API.

Getting API keys

API keys are required to use it. Send us your request by email.

Getting Help

There is a basic documentation about the Isogeo API.

Installing

To use:

pip install --user isogeo-pysdk

For developers:

git clone git@github.com:isogeo/isogeo-api-py-minsdk.git
cd isogeo-api-py-minsdk
python setup.py install

Quickstart

from isogeo_pysdk import Isogeo

# authenticate your client application
isogeo = Isogeo(client_id=app_id,
                client_secret=app_secret)

# get the token
token = isogeo.connect()

# search within catalogs shared to the application
search = isogeo.search(token)

# print some statements
print(isogeo.SUBRESOURCES)  # available sub resources
print("Search __dict__ keys: ", search.keys())  # search response basic structure
print("Search query parameters: ", search.get('query'))  # search response query passed
print("Total count of metadatas shared: ", search.get("total"))  # total of available resources
print("Count of resources got by request: {}\n".format(len(search.get("results"))))  # total of resources returned by search request

Samples are available in the source repository.

For more details, please have a look to the documentation on Read the Docs.

Tests

Tests are performed for each published commit by Travis

To run tests:

pip install --upgrade -r tests/requirements_test.txt
python setup.py install
python -m unittest discover

Build

To package and upload:

.\build_upload.ps1

To build docs:

cd .\docs\
.\build_docs.ps1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

isogeo-pysdk-2.20.2.tar.gz (42.7 kB view hashes)

Uploaded Source

Built Distribution

isogeo_pysdk-2.20.2-py2.py3-none-any.whl (39.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page