A simple python client for interacting with the OSDU API.
Project description
osdupy
A simple python client for the OSDU data platform.
Usage
Installation
pip install osdupy
Example
Initialize the client
If your environment variables (below) have been set, then client.get_client() can be called with no args.
Environment variables: OSDU_API_URL
, OSDU_CLIENT_ID
, OSDU_USER
, OSDU_PASSWORD
from osdu import client
osdu = AwsOsduClient()
If you have not set the above environment variales, then you will need to pass any undefined as args to client.get_client()
from getpass import getpass()
from osdu.client import AwsOsduClient
api_url = 'https://your_api_url'
client_id = 'YOURCLIENTID'
user = 'username@testing.com'
password = getpass()
osdu = AwsOsduClient(api_url, client_id, user, password)
Use the client
# Search for records by query.
query = {
"kind": f"opendes:osdu:*:*"
}
result = osdu.search.query(query, max_results=10)
# Get a record.
record_id = 'opendes:doc:123456789'
result = osdu.storage.get_record(record_id)
See tests for more copmrehensive usage examples.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
osdupy-0.0.2.tar.gz
(4.0 kB
view hashes)
Built Distribution
osdupy-0.0.2-py3-none-any.whl
(6.2 kB
view hashes)