equinor/osdu-sdk-python

Python SDK for working with OSDU

OSDU SDK for Python

This is the OSDU SDK for Python (work in progress).

⚠️ Note that this is a work in progress and is not complete / might contain bugs and might be subject to breaking changes.

Please give your feedback by raising an issue.

Installation

Usage requires that you have a valid python 3.8+ installation on your machine. You might also consider creating a seperate python virtual environment for working with OSDU.

For general usage deploying from PyPi is the easiest and recommended method.

pip install osdu-sdk

If you want to modify the sdk code then see the development wiki for alternative setup steps.

Usage

1. Import necessary items

from osdu.client import OsduClient
from osdu.identity import OsduTokenCredential, OsduMsalInteractiveCredential, OsduEnvironmentCredential

2. Create an instance of OsduTokenCredential, OsduMsalInteractiveCredential, OsduEnvironmentCredential or your own custom class.

credential = OsduMsalInteractiveCredential(client_id, authority, scopes, token_cache)

3. Create a client

client = OsduClient(server, partition, credential)

4. Use the REST interface to call OSDU API's

response = client.get(client.server_url + '/api/search/v2/health/readiness_check')
print(f"Search service: {response.status_code}\t {response.reason}")

For a full example see examples/example.py

Contributing

We welcome any kind of contribution, whether it be reporting issues or sending pull requests.

When contributing to this repository abide by the Equinor Open Source Code of Conduct.

CLI specific issues and requests

If your issue is relevant to the OSDU CLI, please use this repositories issue tracker.

Be sure to search for similar previously reported issues prior to creating a new one. In addition, here are some good practices to follow when reporting issues:

• Add a +1 reaction to existing issues that are affecting you
• Include verbose output (--debug flag) when reporting unexpected error messages
• Include the version of OSDU SDK for Python installed, pip show osdu will report this
• Include the version of OSDU you are using

Code changes

See the wiki page on contributing for more information on submitting code changes.

osdu-sdk-python's Issues

ddms enrichment well log

Better error message in error handling or at least logging in post_returning_json and get_returning_json

When (client.py ) post_returning_json (and get_returing_json and put_returning.json) is called without param ok_status_codes
only the response code 200 is added as status code that is ok before calling self.post. But when another status code than 200 is returned, the error message is " HTTPError(response=response)" which doesn't provide enough information.
It's is necessary to dot into the response proprty of the exception to find the response code. Is it possible to have the error code in the str representation of the HttpError?

'osdu' is not a package

Getting an error when trying to import OsduClient

from osdu.client import OsduClient

produces this error:
ModuleNotFoundError: No module named 'osdu.client'; 'osdu' is not a package