Commit 4d3f9806 authored by Luc Yriarte's avatar Luc Yriarte
Browse files

os-python-client-storage snapshot @c2f88b1

parents
Pipeline #7432 failed with stages
in 5 minutes and 30 seconds
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
venv/
.python-version
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
docs/_build/
# PyBuilder
target/
#Ipython Notebook
.ipynb_checkpoints
#virtualenvs
virtualenv/
.venv/
#build tools
fastapi_client/
#IDE
.idea/
.vscode/
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
\ No newline at end of file
# osdu-data-ecosystem-storage
is projet python client library for the open data ecosystem storage service.
Storage service which handles the metadata ingestion in the Data Ecosystem
This Python package is automatically generated with fastapi_client
from the swagger api definition converted to openapi 3.0 specification using swagger2openapi
## Requirements
Python 3.7
## Installation & Usage
### pip install
```bash
pip install osdu-data-ecosystem-storage
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then loog the the [example application](.§example.py)
## Documentation for API Endpoints
[storageGroupsAdministrationApi](odes_storage/docs/storageGroupsAdministrationApi.md
[storageGroupsAdministrationApi](odes_storage/docs/storageMembersAdministrationApi.md)
## Documentation For Models
[Documentation](../odes_storage/docs/)
## Documentation For Authorization
TODO
## Contributing
### Installing build tools
```
npm install -g swagger2openapi
git clone https://github.com/ChristopheLallement/fastapi_client.git
```
### Build
Convert from swagger spec to openapi spec :
```
swagger2openapi curated-swagger-storage.json -y --outfile openapi-storage.yaml
```
Then generate :
```
rm -rf ./odes_storage & \
./fastapi_client/scripts/generate.sh \
--include-auth \
-i openapi-storage.yaml \
-p odes_storage \
-n odes_storage \
-o ./
```
## Author
clallement@slb.com
\ No newline at end of file
This diff is collapsed.
from odes_storage import AsyncApis as StorageApi, AuthApiClient as StorageClient
from odes_storage.models import (
CreateUpdateRecordsResponse,
DatastoreQueryResult,
Legal,
Record,
StorageAcl,
)
import asyncio
from pprint import pprint
HOSTNAME = "https://os-storage-dot-opendes.appspot.com/api/storage"
TOKEN = "eyJhbGciOiJSUzI1NiIsImtpZCI6ImY5ZDk3YjRjYWU5MGJjZDc2YWViMjAwMjZmNmI3NzBjYWMyMjE3ODMiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI0ODk1NzIxMDc2OTUtb2FjajI0ZnRlNWExN3JtM2VsZ2lsaGJuNDljaWVnaG8uYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI0ODk1NzIxMDc2OTUtb2FjajI0ZnRlNWExN3JtM2VsZ2lsaGJuNDljaWVnaG8uYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMDM0MzY5NjA1NjQ3Njk2ODQzMzUiLCJoZCI6Im9wZW5kZXMucDRkLmNsb3VkLnNsYi1kcy5jb20iLCJlbWFpbCI6ImNsYWxsZW1lbnRAb3BlbmRlcy5wNGQuY2xvdWQuc2xiLWRzLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJhdF9oYXNoIjoiV1RBb1lVLTI5YTU3QmpOaV9IajNndyIsImlhdCI6MTU4NzU0MDI3NCwiZXhwIjoxNTg3NTQzODc0fQ.l3OljSD9N5FhNRbj8E8Gd3dyDj8Qi40r6W4e473tfTvGHzuE6QLpm5Yhp-l43HHHcOt_Gnbm-hEq6l9XXyx4yGAhna8Wp9vgz2HRlQDcXAB1WeYkBhzJ2PCu8QrT_cqahPzH8pqN8mNuTpEzJTVKZQJIm0Crs9DVz2XyIvCaUxX9lEqHKIzCVeRYjdoBKundRw4WKVXtrLd4ZX56fP9s06aUmHdrdN8BFmSn1JS2I8XNtPHarv_kKiItWbZIjWkjvM_OOCwx38oZUztTBq9W-uMh-nIT59PGj7e_RxtGUiEBlvkZroKvHg1wF1WcPOBQ5-EvW1oU19fjWkhyfbuQFQ"
DATA_PARTITION_ID = "opendes"
async def main():
record = Record(
kind="opendes:osdu:wellbore:2.0.0",
acl=StorageAcl(
viewers=["data.default.viewers@opendes.p4d.cloud.slb-ds.com"],
owners=["data.default.owners@opendes.p4d.cloud.slb-ds.com"],
),
legal=Legal(
legaltags=["opendes-public-usa-dataset-1"],
otherRelevantDataCountries=["US"],
),
data={"msg": "hello world, from Data Ecosystem"},
)
client = StorageApi(
StorageClient(host=HOSTNAME, token=TOKEN)
)
created_record_response = await client.records_api.create_or_update_records(
data_partition_id=DATA_PARTITION_ID,
skipdupes=False,
record=[record],
)
assert isinstance(created_record_response, CreateUpdateRecordsResponse)
assert created_record_response.record_ids[0]
computed_record = await client.records_api.get_record(
data_partition_id=DATA_PARTITION_ID,
id=created_record_response.record_ids[0],
)
assert isinstance(computed_record, Record)
assert record.kind == computed_record.kind
assert record.acl == computed_record.acl
assert record.legal == computed_record.legal
assert record.data == computed_record.data
pprint(computed_record)
if __name__ == "__main__":
asyncio.run(main())
import inspect
from odes_storage import models
from odes_storage.api_client import ApiClient, AsyncApis, SyncApis # noqa F401
from odes_storage.auth_api_client import AuthApiClient
from odes_storage.exceptions import ResponseValidationError, UnexpectedResponse
for model in inspect.getmembers(models, inspect.isclass):
if model[1].__module__ == "odes_storage.models":
model_class = model[1]
model_class.update_forward_refs()
# flake8: noqa E501
from asyncio import get_event_loop
from typing import TYPE_CHECKING, Awaitable
from fastapi.encoders import jsonable_encoder
from odes_storage import models as m
if TYPE_CHECKING:
from odes_storage.api_client import ApiClient
class _QueryApi:
def __init__(self, api_client: "ApiClient"):
self.api_client = api_client
def _build_for_fetch_records(
self, data_partition_id: str, multi_record_ids: m.MultiRecordIds = None
) -> Awaitable[m.MultiRecordInfo]:
"""
The API fetches multiple records at once. Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.
"""
headers = {"data-partition-id": str(data_partition_id)}
body = jsonable_encoder(multi_record_ids)
return self.api_client.request(
type_=m.MultiRecordInfo, method="POST", url="/v2/query/records", headers=headers, json=body
)
def _build_for_fetch_records_with_optional_conversion(
self, data_partition_id: str, multi_record_request: m.MultiRecordRequest = None
) -> Awaitable[m.MultiRecordResponse]:
"""
Fetch records and do corresponding conversion as user requested, no more than 20 records per request.
"""
headers = {"data-partition-id": str(data_partition_id)}
body = jsonable_encoder(multi_record_request)
return self.api_client.request(
type_=m.MultiRecordResponse, method="POST", url="/v2/query/records:batch", headers=headers, json=body
)
def _build_for_get_all_kinds(
self, data_partition_id: str, cursor: str = None, limit: int = None
) -> Awaitable[m.DatastoreQueryResult]:
"""
The API returns a list of all kinds in the specific {Data-Partition-Id}. Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"""
query_params = {}
if cursor is not None:
query_params["cursor"] = str(cursor)
if limit is not None:
query_params["limit"] = str(limit)
headers = {"data-partition-id": str(data_partition_id)}
return self.api_client.request(
type_=m.DatastoreQueryResult, method="GET", url="/v2/query/kinds", params=query_params, headers=headers,
)
def _build_for_get_all_record_from_kind(
self, data_partition_id: str, cursor: str = None, limit: int = None, kind: str = None
) -> Awaitable[m.DatastoreQueryResult]:
"""
The API returns a list of all record ids which belong to the specified kind. Required roles: 'users.datalake.ops'.
"""
query_params = {}
if cursor is not None:
query_params["cursor"] = str(cursor)
if limit is not None:
query_params["limit"] = str(limit)
if kind is not None:
query_params["kind"] = str(kind)
headers = {"data-partition-id": str(data_partition_id)}
return self.api_client.request(
type_=m.DatastoreQueryResult, method="GET", url="/v2/query/records", params=query_params, headers=headers,
)
class AsyncQueryApi(_QueryApi):
async def fetch_records(
self, data_partition_id: str, multi_record_ids: m.MultiRecordIds = None
) -> m.MultiRecordInfo:
"""
The API fetches multiple records at once. Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.
"""
return await self._build_for_fetch_records(
data_partition_id=data_partition_id, multi_record_ids=multi_record_ids
)
async def fetch_records_with_optional_conversion(
self, data_partition_id: str, multi_record_request: m.MultiRecordRequest = None
) -> m.MultiRecordResponse:
"""
Fetch records and do corresponding conversion as user requested, no more than 20 records per request.
"""
return await self._build_for_fetch_records_with_optional_conversion(
data_partition_id=data_partition_id, multi_record_request=multi_record_request
)
async def get_all_kinds(
self, data_partition_id: str, cursor: str = None, limit: int = None
) -> m.DatastoreQueryResult:
"""
The API returns a list of all kinds in the specific {Data-Partition-Id}. Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"""
return await self._build_for_get_all_kinds(data_partition_id=data_partition_id, cursor=cursor, limit=limit)
async def get_all_record_from_kind(
self, data_partition_id: str, cursor: str = None, limit: int = None, kind: str = None
) -> m.DatastoreQueryResult:
"""
The API returns a list of all record ids which belong to the specified kind. Required roles: 'users.datalake.ops'.
"""
return await self._build_for_get_all_record_from_kind(
data_partition_id=data_partition_id, cursor=cursor, limit=limit, kind=kind
)
class SyncQueryApi(_QueryApi):
def fetch_records(self, data_partition_id: str, multi_record_ids: m.MultiRecordIds = None) -> m.MultiRecordInfo:
"""
The API fetches multiple records at once. Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.
"""
coroutine = self._build_for_fetch_records(
data_partition_id=data_partition_id, multi_record_ids=multi_record_ids
)
return get_event_loop().run_until_complete(coroutine)
def fetch_records_with_optional_conversion(
self, data_partition_id: str, multi_record_request: m.MultiRecordRequest = None
) -> m.MultiRecordResponse:
"""
Fetch records and do corresponding conversion as user requested, no more than 20 records per request.
"""
coroutine = self._build_for_fetch_records_with_optional_conversion(
data_partition_id=data_partition_id, multi_record_request=multi_record_request
)
return get_event_loop().run_until_complete(coroutine)
def get_all_kinds(self, data_partition_id: str, cursor: str = None, limit: int = None) -> m.DatastoreQueryResult:
"""
The API returns a list of all kinds in the specific {Data-Partition-Id}. Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"""
coroutine = self._build_for_get_all_kinds(data_partition_id=data_partition_id, cursor=cursor, limit=limit)
return get_event_loop().run_until_complete(coroutine)
def get_all_record_from_kind(
self, data_partition_id: str, cursor: str = None, limit: int = None, kind: str = None
) -> m.DatastoreQueryResult:
"""
The API returns a list of all record ids which belong to the specified kind. Required roles: 'users.datalake.ops'.
"""
coroutine = self._build_for_get_all_record_from_kind(
data_partition_id=data_partition_id, cursor=cursor, limit=limit, kind=kind
)
return get_event_loop().run_until_complete(coroutine)
# flake8: noqa E501
from asyncio import get_event_loop
from typing import TYPE_CHECKING, Any, Awaitable, List
from fastapi.encoders import jsonable_encoder
from odes_storage import models as m
if TYPE_CHECKING:
from odes_storage.api_client import ApiClient
class _RecordsApi:
def __init__(self, api_client: "ApiClient"):
self.api_client = api_client
def _build_for_create_or_update_records(
self, data_partition_id: str, skipdupes: bool = None, record: List[m.Record] = None
) -> Awaitable[m.CreateUpdateRecordsResponse]:
"""
The API represents the main injection mechanism into the Data Ecosystem. It allows records creation and/or update. When no record id is provided or when the provided id is not already present in the Data Ecosystem then a new record is created. If the id is related to an existing record in the Data Ecosystem then an update operation takes place and a new version of the record is created. Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"""
query_params = {}
if skipdupes is not None:
query_params["skipdupes"] = str(skipdupes)
headers = {"data-partition-id": str(data_partition_id)}
body = jsonable_encoder(record)
return self.api_client.request(
type_=m.CreateUpdateRecordsResponse,
method="PUT",
url="/v2/records",
params=query_params,
headers=headers,
json=body,
)
def _build_for_delete_record(self, id: str, data_partition_id: str, body: Any = None) -> Awaitable[None]:
"""
The API performs a logical deletion of the given record. This operation can be reverted later. Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"""
path_params = {"id": str(id)}
headers = {"data-partition-id": str(data_partition_id)}
body = jsonable_encoder(body)
return self.api_client.request(
type_=None,
method="POST",
url="/v2/records/{id}:delete",
path_params=path_params,
headers=headers,
json=body,
)