Skip to main content

A package to facilitate access to the Arlula Imagery Marketplace API

Project description

Arlula API Python Package

About

This package provides a core interface for interacting with the Arlula API. This package can be found on PyPI.

Prerequisites

This package requires an active Arlula account and access to the API credentials. If you don't have an account, you can create one at api.arlula.com/signup.

Installation

pip install arlulacore

Initiation

Instantiate a Session object using your API credentials as below. This will validate your credentials and store them for the remainder of the session.

import arlulacore

"""opening a session"""
arlula_session = arlulacore.Session(key, secret)

API Endpoints

This package contains methods for each of the supported API endpoints, namespaced by API namespace. Each namespace inherits the session defined above

Archive

api = arlulacore.ArlulaAPI(arlula_session)

archive = api.archiveAPI()

# Search for imagery around sydney between 2020-Jan-1 and 2020-Feb-1
# With at least 10m resolution
search_result = archive.search(
    arlulacore.SearchRequest(
        start=date(2020, 1, 1), 
        res=10,
    )
    .set_point_of_interest(-33.8688, 151.2093)
    .set_end(date(2020, 2, 1))
)

# Order a specific image from the archive, using the id from above, and (optionally) 
# email jane.doe@gmail.com and john.smith@gmail.com when it is complete.
order_result = archive.order(
    arlulacore.OrderRequest(
        id="cade11f4-8b4d-43e1-8cb1-3bce85111a01",
        eula="Supplier's EULA",
        seats=1,
    )
    .set_emails(["john.smith@gmail.com", "jane.doe@gmail.com"])
)

Orders

orders = api.ordersAPI()

# Get the status and details of an order
order = orders.get(
    id="cade11f4-8b4d-43e1-8cb1-3bce85111a01",
)

# Get a specific resource, for example thumbnails, tiffs, json metadata.
# Streams to a file and returns the file handle.
f = orders.get_resource_as_file(
    id="b7adb198-3e6e-4217-9e67-fb26eb355cc4",
    filepath="downloads/thumbnail.jpg",
)

# Get a specific resource, for example thumbnails, tiffs, json metadata.
# Returns the memory buffer of the requested resource.
# Not recommended for large files.
b = orders.get_resource_as_memory(
    id="b7adb198-3e6e-4217-9e67-fb26eb355cc4",
)

# List the details and status of all orders made
order_list = orders.list_orders()

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

arlulacore-2.0.2.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

arlulacore-2.0.2-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file arlulacore-2.0.2.tar.gz.

File metadata

  • Download URL: arlulacore-2.0.2.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for arlulacore-2.0.2.tar.gz
Algorithm Hash digest
SHA256 7475a960e98dcddcbf599ab72cecf193ef7972f76aca917e3cf8e454ab975d93
MD5 07cac0cb26ec5d34f8aa9cc0fb3a04ec
BLAKE2b-256 829a7670a0dfb54cd68ed6a726170314c60765f02d70194c2c0cc295d3c8d30b

See more details on using hashes here.

File details

Details for the file arlulacore-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: arlulacore-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for arlulacore-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4effa587793797cc35a9bf968eecb83492c57e6dfcd59193a905e76540e8e2d6
MD5 45341c789b4caff0040071e141509827
BLAKE2b-256 5ed9dd439166d476cb580c9128487abff8ec36618987ca9562415720745db34e

See more details on using hashes here.

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