Skip to main content

Python package to make it easy to use Isogeo REST API

Project description

Isogeo API Python SDK

PyPI PyPI - Python Version

Build Status Build Status codecov

Documentation Status

A Python package to use Isogeo REST API.

Requirements

Isogeo API requires oAuth2 authentication. To obtain credentials, send us your request by email projects+api@isogeo.com.

Based on the well known requests package.

Documentation

Usage in a nutshell

pip install --user isogeo-pysdk
# using pipenv
pipenv install isogeo-pysdk

Quickstart

from isogeo_pysdk import Isogeo

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

# get the token
isogeo.connect()

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

# print some statements
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 <https://github.com/isogeo/isogeo-api-py-minsdk/tree/master/isogeo_pysdk/samples>_.

Tests

Tests are performed for each published commit:

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

Or using the included Powershell script:

.\tool_test_coverage.ps1

Coverage

Test coverage is published on codecov.io.

Build

To package and upload:

.\tool_build_upload.ps1

To build docs:

.\tool_docs_build.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.21.1.tar.gz (31.0 kB view hashes)

Uploaded source

Built Distribution

isogeo_pysdk-2.21.1-py3-none-any.whl (53.3 kB view hashes)

Uploaded py3

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