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.2.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

isogeo_pysdk-2.21.2-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

Details for the file isogeo-pysdk-2.21.2.tar.gz.

File metadata

  • Download URL: isogeo-pysdk-2.21.2.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for isogeo-pysdk-2.21.2.tar.gz
Algorithm Hash digest
SHA256 5c7a885cef83620cb90301ab83875102353d6c786d8c88f8a8cc1402324fbce9
MD5 57df3347498adc21c45a62ab85a6a61a
BLAKE2b-256 afa279bb2c57a6d9ac8636a26e124b50496e81b8f405bd305688e0ac2a421b57

See more details on using hashes here.

File details

Details for the file isogeo_pysdk-2.21.2-py3-none-any.whl.

File metadata

  • Download URL: isogeo_pysdk-2.21.2-py3-none-any.whl
  • Upload date:
  • Size: 53.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for isogeo_pysdk-2.21.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e9b38a9ab5b833cb451ed36f89532a680c20fc16203df5b3207f970f136e1e7f
MD5 9b58ff35a242366fe3b5f41db868aa32
BLAKE2b-256 15b6e20a9edaa02e1d0ca4467a0c59f556d9ee0560bcdea7a9bb9ac8be832d0e

See more details on using hashes here.

Supported by

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