unitycatalog-client 0.2.1__py3-none-any.whl

unitycatalog_client-0.2.1.dist-info/METADATA

@@ -0,0 +1,199 @@
+Metadata-Version: 2.3
+Name: unitycatalog-client
+Version: 0.2.1
+Summary: Official Python SDK for Unity Catalog
+Project-URL: homepage, https://www.unitycatalog.io/
+Project-URL: issues, https://github.com/unitycatalog/unitycatalog/issues
+Project-URL: repository, https://github.com/unitycatalog/unitycatalog
+Author-email: Unity Catalog Developers <dev-feedback@unitycatalog.com>
+Maintainer-email: Denny Lee <denny.lee@databricks.com>, Ben Wilson <benjamin.wilson@databricks.com>, Tathagata Das <tathagata.das1565@gmail.com>
+License: Apache-2.0
+Keywords: sdk,unitycatalog
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.9
+Requires-Dist: aiohttp-retry>=2.8.3
+Requires-Dist: aiohttp>=3.8.4
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: urllib3>=1.25.3
+Description-Content-Type: text/markdown
+
+# Unity Catalog Python Client SDK
+
+Welcome to the official Python Client SDK for Unity Catalog!
+
+Unity Catalog is the industry's only universal catalog for data and AI.
+
+- **Multimodal interface supports any format, engine, and asset**
+    - Multi-format support: It is extensible and supports Delta Lake, Apache Iceberg and Apache Hudi via UniForm, Apache Parquet, JSON, CSV, and many others.
+    - Multi-engine support: With its open APIs, data cataloged in Unity can be read by many leading compute engines.
+    - Multimodal: It supports all your data and AI assets, including tables, files, functions, AI models.
+- **Open source API and implementation** - OpenAPI spec and OSS implementation (Apache 2.0 license). It is also compatible with Apache Hive's metastore API and Apache Iceberg's REST catalog API. Unity Catalog is currently a sandbox project with LF AI and Data Foundation (part of the Linux Foundation).
+- **Unified governance** for data and AI - Govern and secure tabular data, unstructured assets, and AI assets with a single interface.
+
+## Python Client SDK
+
+The Unity Catalog Python SDK provides a convenient Python-native interface to all of the functionality of the Unity Catalog
+REST APIs. The library includes interfaces for all supported public modules.
+
+This library is generated using the [OpenAPI Generator](https://openapi-generator.tech/docs/generators/python) toolkit, providing client interfaces using the `aiohttp` request handling library.
+
+## Installation
+
+The Python Client SDK and associated shared namespace package for Unity Catalog use [hatch](https://hatch.pypa.io/latest/) as their supported build backend.
+
+To ensure that you can install the package, install `hatch` via any of the listed options [here](https://hatch.pypa.io/latest/install/).
+
+To use the `unitycatalog-client` SDK, you can install directly from PyPI:
+
+```sh
+pip install unitycatalog-client
+```
+
+To install from source, you will need to fork and clone the [unitycatalog repository](https://github.com/unitycatalog/unitycatalog) locally.
+
+To build the Python source locally, you will need to have `JDK17` installed and activated.
+
+Once your configuration supports the execution of [sbt](https://www.scala-sbt.org/), you can run the following within the root
+of the repository to generate the Python Client SDK source:
+
+```sh
+build/sbt pythonClient/generate
+```
+
+The source code will be generated at `unitycatalog/clients/python/target`. 
+
+You can then install the package in editable mode from the repository root:
+
+```sh
+pip install -e clients/python/target
+```
+
+## Usage
+
+To get started with using the Python Client SDK, first ensure that you have a running Unity Catalog server to connect to.
+You can follow instructions [here](https://docs.unitycatalog.io/quickstart/) to quickly get started with setting up
+a local Unity Catalog server if needed.
+
+Once the server is running, you can set up the Python client to make async requests to the Unity Catalog server.
+
+For the examples listed here, we will be using a local unauthenticated server for simplicity's sake.
+
+```python
+from unitycatalog.client import Configuration
+
+
+config = Configuration()
+config.host = "http://localhost:8080/api/2.1/unity-catalog"
+```
+
+Once we have our configuration, we can set our client that we will be using for each request:
+
+```python
+from unitycatalog.client import ApiClient
+
+
+client = ApiClient(configuration=config)
+```
+
+With our client configured and instantiated, we can use any of the Unity Catalog APIs by importing from the
+`client` namespace directly and send requests to the server.
+
+```python
+from unitycatalog.client import CatalogsApi
+
+
+catalogs_api = CatalogsApi(api_client=client)
+my_catalogs = await catalogs_api.list_catalogs()
+```
+
+>Note: APIs that support pagination (such as `list_catalogs`) should have continutation token logic for assembling the paginated
+return values into a single collection.
+
+A simple example of consuming a paginated response is:
+
+```python
+async def list_all_catalogs(catalog_api):
+  token = None
+  catalogs = []
+  while True:
+    results = await catalog_api.list_catalogs(page_token=token)
+    catalogs += results.catalogs
+    if next_token := results.next_page_token:
+      token = next_token
+    else:
+      break
+  return catalogs
+
+my_catalogs = await list_all_catalogs(catalogs_api)
+```
+
+Creating a new catalog with the Python SDK is straight-forward:
+
+```python
+from unitycatalog.client.models import CreateCatalog, CatalogInfo
+
+
+async def create_catalog(catalog_name, catalog_api, comment=None):
+    new_catalog = CreateCatalog(
+        name=catalog_name,
+        comment=comment or ""
+    )
+    return await catalog_api.create_catalog(create_catalog=new_catalog)
+
+await create_catalog("MyNewCatalog", catalog_api=catalogs_api, comment="This is a new catalog.")
+```
+
+Adding a new Schema to our created Catalog is similarly simple:
+
+```python
+from unitycatalog.client import SchemasApi
+from unitycatalog.client import CreateSchema, SchemaInfo
+
+
+schemas_api = SchemasApi(api_client=client)
+
+async def create_schema(schema_name, catalog_name, schema_api, comment=None):
+    new_schema = CreateSchema(
+        name=schema_name,
+        catalog_name=catalog_name,
+        comment=comment or ""
+    )
+    return await schema_api.create_schema(create_schema=new_schema)
+
+await create_schema(schema_name="MyNewSchema", catalog_name="MyNewCatalog", schema_api=schemas_api, comment="This is a new schema.")
+```
+
+And listing the schemas within our newly created Catalog (note that if you expect paginated responses, ensure that you are passing
+continuation tokens as shown above in `list_all_catalogs`):
+
+```python
+await schemas_api.list_schemas(catalog_name="MyNewCatalog")
+```
+
+## Feedback
+
+Have requests for the Unity Catalog project? Interested in getting involved in the Open Source project?
+
+See the [repository on GitHub](https://github.com/unitycatalog/unitycatalog)
+
+Read [the documentation](https://www.unitycatalog.io/) for more guidance and examples!

unitycatalog_client-0.2.1.dist-info/RECORD

@@ -0,0 +1,82 @@
+unitycatalog/client/__init__.py,sha256=kDCuHsxjSRzSmhoT6w83_b7Aap27U8PYyINxtYnI5O4,6317
+unitycatalog/client/api_client.py,sha256=vixXEuRAj_O7F_TeciWR_O5k0Kn99kl0X1gWzei3_68,26487
+unitycatalog/client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+unitycatalog/client/configuration.py,sha256=NHmz6y2brp9_yx0ty5McPzPlVYDIzevrcPJVXuWxMyI,14264
+unitycatalog/client/exceptions.py,sha256=Sy_fUb_HYFLdf6x-lOGPqfJcyroWog2i4Pl1Zq6MLB8,5980
+unitycatalog/client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unitycatalog/client/rest.py,sha256=9IOUYysdwTn-tpPUfhtoqXOM5aQNtDqWIQT6c_DznOs,6855
+unitycatalog/client/api/__init__.py,sha256=Zv5glrAbLi0taOq0KV-RH9N4ArHvkaRiyp0a5v1vMrE,640
+unitycatalog/client/api/catalogs_api.py,sha256=Lrfr2OE24x03VDapaFqvygdzH_oVSs2yQwRIQ41qyWU,56095
+unitycatalog/client/api/functions_api.py,sha256=RuKziubMK0qq44Yloex2FFWCh7EEk68v3GFujtjuSus,47907
+unitycatalog/client/api/grants_api.py,sha256=QDemj-ZmIuc46rOAyFG-6M-GA_1nCT7DmIPW-aT4mug,25211
+unitycatalog/client/api/model_versions_api.py,sha256=sVQEO6AZqCH5w-zYtON20q10Z7b2XmiiBSrlCwdRa6k,71961
+unitycatalog/client/api/registered_models_api.py,sha256=M_VQS09qqUaK1xaze42KPtyNLQmB1nUYUaNdLuQCq74,60355
+unitycatalog/client/api/schemas_api.py,sha256=HSTvpVA4GgNqv_iCxSuK4FHdOiyimB8sf3XnNdHNye0,57235
+unitycatalog/client/api/tables_api.py,sha256=U1jorniynfDnLfdOekh44mcZxhF6zAVOsyQvJEOqq1c,46733
+unitycatalog/client/api/temporary_credentials_api.py,sha256=fynS3xCYuBqsHU8NH7gQFFOobQK3YDg27l4Oth1JUoU,45834
+unitycatalog/client/api/volumes_api.py,sha256=83d1CDqHnDNi2UZZlBpGarjpX6tkFRAr6u2UJ3ouWhM,60660
+unitycatalog/client/models/__init__.py,sha256=He-DukrzJns5eEeh8fPCuElKLYEi58IUvg18WgeOAAI,5136
+unitycatalog/client/models/aws_credentials.py,sha256=4q7j-hfcMPSJmrxqtsWIpFI_Hz4QLNgiwXq5qT0szwQ,3094
+unitycatalog/client/models/azure_user_delegation_sas.py,sha256=_9YbgyAEP92oZhHcRKEjeYEWSTZktFJlxr5eZC1Gq8Q,2612
+unitycatalog/client/models/catalog_info.py,sha256=X43CG6vjgN_eibXI-FWQbdeVp7ef5wYRSeHVxtcdhwE,3972
+unitycatalog/client/models/column_info.py,sha256=V6Il0mT260_bfWPQdJMJNrk8zIFct8LrOLAxaUyq9e0,4427
+unitycatalog/client/models/column_type_name.py,sha256=uSFZvdjxMH-5JGU3tBCdMK4Dxl05OUQ0gXFUxyETGpU,1225
+unitycatalog/client/models/create_catalog.py,sha256=nTQvRwsH-E9z2aCwoc5mSNroeSqh8yl7PqHM_UTdvlU,2903
+unitycatalog/client/models/create_function.py,sha256=pXB3B9N0ANq2qXM4m0-vrEACNOhfcI3p2Fj_G61w14g,7815
+unitycatalog/client/models/create_function_request.py,sha256=esO2MLOHH24PkS_YCykLZP4HO_1XaEKVBLLeLyShIMc,2869
+unitycatalog/client/models/create_model_version.py,sha256=_2-iDc5FXaU9q_tJV8pRciaUHnuwHvQBtAB5WcVMTGY,3428
+unitycatalog/client/models/create_registered_model.py,sha256=0B4iWHJxxI1boQg8lOBBeoGW6Ash5P0281bXgPwzhGE,3070
+unitycatalog/client/models/create_schema.py,sha256=TETEpouW-rLhktgsusOFBdI4IaxFza7W3FpSBe6BqbA,3070
+unitycatalog/client/models/create_table.py,sha256=SC26cKpgGale3kAnsGKeugjc7w7okhw_eEb6JVVVpGM,4379
+unitycatalog/client/models/create_volume_request_content.py,sha256=IVcZiEhAud70cK3pQY4UOP0S9AXZ4FYQSMvsSD2LzIg,3513
+unitycatalog/client/models/data_source_format.py,sha256=z_Nu08EG1Pi60KVQebJysUOtXNdZLlJpUYODkIuXNZk,857
+unitycatalog/client/models/dependency.py,sha256=n07cMFkkA9xxs5bCjy-cv-rKKRSWghakNGDOImouM9U,3298
+unitycatalog/client/models/dependency_list.py,sha256=7-wgwYew6RG-apXd0j-J_gqYGauFqpgFfFUXwx9_-6o,3078
+unitycatalog/client/models/finalize_model_version.py,sha256=Sx21el8Ja5Jb0w1O89wh_iLuV6SAPv_R1eQ1967_S_c,2759
+unitycatalog/client/models/function_dependency.py,sha256=4PcGEE1bsFXsyHe9ggWmEellk-ygOwksNjWqDWtxBMM,2713
+unitycatalog/client/models/function_info.py,sha256=U2tZx9UxNogzG1teb_kmjUE2UkM2D5wUxd0UwUYl0Sw,9680
+unitycatalog/client/models/function_parameter_info.py,sha256=fKs3CHEWYIZZqSbM_YNDmJGREREQBIvJqpH5sMNBHR4,4598
+unitycatalog/client/models/function_parameter_infos.py,sha256=PKkixNBYmubzzA3A_poitBeNvptuO-hrNMO1cxmGoV8,3187
+unitycatalog/client/models/function_parameter_mode.py,sha256=aQtVPLlE0Yi4dPZ5kaI-j7lHz28SOF89tiLhpzDqKZE,768
+unitycatalog/client/models/function_parameter_type.py,sha256=pqpsAtZNUBFL09iU1wqwfNAz_95kQ4a6JqMgBP8mPio,792
+unitycatalog/client/models/gcp_oauth_token.py,sha256=sAZmWYS4QMgQiRupTAUxXtMfizQi83Lgj9nfGmPczu4,2578
+unitycatalog/client/models/generate_temporary_model_version_credential.py,sha256=_ls-dUGR_w5s80R0zDOklDrvPg4yPYmM8hDqS03X1Ws,3594
+unitycatalog/client/models/generate_temporary_path_credential.py,sha256=KmaVu3_GfJFrCzP-Lt2VqtZM0KXlYGgV_4xvmsMheyQ,2813
+unitycatalog/client/models/generate_temporary_table_credential.py,sha256=o6S4IkMI_MKxDnvPhHI5X7xYG_qWnUvfN9qa09CDWBU,2878
+unitycatalog/client/models/generate_temporary_volume_credential.py,sha256=XkmzLCgNNhKmBzgjL0I-UX3jJ2nek4xQ5N1NXXdmTlA,2892
+unitycatalog/client/models/list_catalogs_response.py,sha256=6ND3tFq_Nz2wIL57E0rvnU6Qt6rs8L9Yxdbcwhg_fvY,3430
+unitycatalog/client/models/list_functions_response.py,sha256=YPqxBXEhV4GLCymPajiQZS-xuQ7zai0ErsYMfOAIx8Q,3448
+unitycatalog/client/models/list_model_versions_response.py,sha256=tYY93Bymb9aUkfcU3tH4L3FUQA0mVu5FJZYaAjHmjH4,3531
+unitycatalog/client/models/list_registered_models_response.py,sha256=uoS_qJlbJ8fETtLsmV0nRpZs6jEteuXI9gy7HiWakTU,3574
+unitycatalog/client/models/list_schemas_response.py,sha256=Jm8G8TeLP3U3RvrV0CnUvokA_iNZYPQoaF0I0HcOi80,3412
+unitycatalog/client/models/list_tables_response.py,sha256=MD_Mr7lZChQpBhAKWzO5_MLKSurr93sc484KQ0s_pIk,3394
+unitycatalog/client/models/list_volumes_response_content.py,sha256=eV-OCybSsnuXQ8wOGMCSU_7os93SoZFbmhU6ubUPZHQ,3376
+unitycatalog/client/models/model_version_info.py,sha256=jsv0kP_FQsoJJquBLPE39Vh_EzlxV6RDUmeDX6W6szs,5224
+unitycatalog/client/models/model_version_operation.py,sha256=UBq-iiAqtwwmguwpeyYaC5MI03wDU-sUmVs_n2pQEZ0,916
+unitycatalog/client/models/model_version_status.py,sha256=ubmDHly9ynPssf9dx5RXoq1o3TiyYUEMMQCynDx6HXw,1356
+unitycatalog/client/models/path_operation.py,sha256=dAB7oT6HswJCIStKHRVamAJc4wYuQoFvYwDKaseXsFg,882
+unitycatalog/client/models/permissions_change.py,sha256=9FBo2b_Gvm71OMB_H6iCChLd9c_uIhI3cjq2jGfVsk8,2904
+unitycatalog/client/models/permissions_list.py,sha256=BaYz1iFq40qI2sE8d0HYEEQqoju1LDHjBuwHMJFB7Ps,3177
+unitycatalog/client/models/principal_type.py,sha256=FROaSFdqrIcyvVDhHquxJShpQpAQVwD5vBfQ5XIJdjo,767
+unitycatalog/client/models/privilege.py,sha256=Pr0a_KNCFIHFWMRWYckdEgX-mi0Zc949duQgoAIGEik,1098
+unitycatalog/client/models/privilege_assignment.py,sha256=BlOmMbiObfTRJVDZlH9B1702ymMEDcxX9pfSEbi_fZs,2819
+unitycatalog/client/models/registered_model_info.py,sha256=uOSc6wH1zK10Vxj1l08UXQcCcC2e06NZGaezGJeRfhA,4787
+unitycatalog/client/models/schema_info.py,sha256=wMECDsuRdS_rPZ7viNEXPPmBproHtQTgNaurmzzA8MY,4383
+unitycatalog/client/models/securable_type.py,sha256=xPIO072RjDuwNdppETjp6JzAAMjMR8vA7oV15ebTtZ4,912
+unitycatalog/client/models/table_dependency.py,sha256=GY-JpIjzzbtTb-RGR6VBcrBma-4nNUGb3Oy_p0_Tm-g,2683
+unitycatalog/client/models/table_info.py,sha256=X83vpFOuP6C7oXicz4bjZ91GS06M6_1HiBOTvmPMPqc,5624
+unitycatalog/client/models/table_operation.py,sha256=mMk0TBTJBdLXE2w7KC6VhfA5DlJRxnkAgnyhOkuT-Wo,823
+unitycatalog/client/models/table_type.py,sha256=sy81bdJ3T1hmvFjhhNYvSbhGsiwUpWXmb4513o0xKXw,754
+unitycatalog/client/models/temporary_credentials.py,sha256=qVWF5Q8NzxyJ2cTGhEV5ordpnVL0BJUGRCQC0SSn8LA,4341
+unitycatalog/client/models/update_catalog.py,sha256=7cfBcXSaSw7xZWstvYalN8WE0Et5jTzaYBZOmOn2yRQ,2952
+unitycatalog/client/models/update_model_version.py,sha256=la61fVfV_6pNW86hEDsh4k_d8dmXooOq4UoDdiHZuSA,2614
+unitycatalog/client/models/update_permissions.py,sha256=GadsFuD5aUDPlHpUT2UGKYOyEJpp_mtEFRRzk4Y4lAw,3045
+unitycatalog/client/models/update_registered_model.py,sha256=UHjcmh8HV1SIjJ96i3FeKrW1Tm_JNJ9x27RdGoaz3IQ,2778
+unitycatalog/client/models/update_schema.py,sha256=n7TRTEgbKvZTAkGjyS6BJ-8KCLM-X3qkhjZbWn9mJEk,2947
+unitycatalog/client/models/update_volume_request_content.py,sha256=AqO3TIEOspMj73xscxmGu8X2LfAAl6cKUSKasDltyH4,2889
+unitycatalog/client/models/volume_info.py,sha256=VgpFY4NlMviEdAeW4utPQ0igdlod9h7iPPGkmL0tbOI,4899
+unitycatalog/client/models/volume_operation.py,sha256=P0M12SwTLkPCHdyE2uUCOxvLwjzn6nRoiaeZ7IyHDek,846
+unitycatalog/client/models/volume_type.py,sha256=U4moIdAzO31TKjfI5Vfp89zYYMqvuDbKD_woOSZINIg,769
+unitycatalog_client-0.2.1.dist-info/METADATA,sha256=qd77QXQtrhQ_6Cr9o01aHjlXkQij7IZHS-zjzqYI6Q4,7809
+unitycatalog_client-0.2.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+unitycatalog_client-0.2.1.dist-info/RECORD,,

unitycatalog_client-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any