Commit 1d0b8352 authored by Dmitriy Rudko's avatar Dmitriy Rudko 💬
Browse files

Merge branch 'readme_updates' into 'master'

GONRG-756: README.md updates

See merge request osdu/platform/system/sdks/common-python-sdk!2
parents 9ba34d19 9ceb64a5
# OSDU Python SDK
## Contents
* [Introduction](#introduction)
* [Getting Started](#getting-started)
* [Testing](#testing)
* * [Running E2E Tests](#running-e2e-tests)
* [Licence](#licence)
# Introduction
OSDU DAGs are cloud platform-agnostic by design. However, there are specific implementation requirements by cloud
platforms, and the OSDU R2 Prototype provides a dedicated Python SDK to make sure that DAGs are independent from the
cloud platforms.
......@@ -15,6 +26,9 @@ calling the OSDU services.
The Python SDK is a package to interface with OSDU microservices.
# Getting Started
To install this package:
1. Install `setuptools` and `wheel`:
......@@ -46,3 +60,29 @@ python -m pip install <YOUR_PATH_TO_PYTHON_SDK>/dist/osdu_api-0.0.1-py3-none-any
```python
from osdu_api.storage.record_client import RecordClient
```
## Testing
### Running E2E Tests
Specify of end-services URLs into `tests/osdu_api.yaml` and run
```sh
pytest test
```
## Licence
Copyright © Google LLC
Copyright © EPAM Systems
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment