lambdadb 0.1.3__tar.gz → 0.3.0__tar.gz

{lambdadb-0.1.3 → lambdadb-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lambdadb
-Version: 0.1.3
+Version: 0.3.0
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -9,8 +9,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: httpcore (>=1.0.9)
 Requires-Dist: httpx (>=0.28.1)
 Requires-Dist: pydantic (>=2.11.2)
+Project-URL: Repository, https://github.com/lambdadb/lambdadb-python-client.git
 Description-Content-Type: text/markdown
 
 # LambdaDB Python SDK
@@ -33,21 +35,21 @@ LambdaDB API: LambdaDB Open API Spec
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
-* [LambdaDB Python SDK](#lambdadb-python-sdk)
-  * [SDK Installation](#sdk-installation)
-  * [IDE Support](#ide-support)
-  * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication)
-  * [Available Resources and Operations](#available-resources-and-operations)
-  * [Retries](#retries)
-  * [Error Handling](#error-handling)
-  * [Server Selection](#server-selection)
-  * [Custom HTTP Client](#custom-http-client)
-  * [Resource Management](#resource-management)
-  * [Debugging](#debugging)
-* [Development](#development)
-  * [Maturity](#maturity)
-  * [Contributions](#contributions)
+* [LambdaDB Python SDK](https://github.com/lambdadb/lambdadb-python-client/blob/master/#lambdadb-python-sdk)
+  * [SDK Installation](https://github.com/lambdadb/lambdadb-python-client/blob/master/#sdk-installation)
+  * [IDE Support](https://github.com/lambdadb/lambdadb-python-client/blob/master/#ide-support)
+  * [SDK Example Usage](https://github.com/lambdadb/lambdadb-python-client/blob/master/#sdk-example-usage)
+  * [Authentication](https://github.com/lambdadb/lambdadb-python-client/blob/master/#authentication)
+  * [Available Resources and Operations](https://github.com/lambdadb/lambdadb-python-client/blob/master/#available-resources-and-operations)
+  * [Retries](https://github.com/lambdadb/lambdadb-python-client/blob/master/#retries)
+  * [Error Handling](https://github.com/lambdadb/lambdadb-python-client/blob/master/#error-handling)
+  * [Server Selection](https://github.com/lambdadb/lambdadb-python-client/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/lambdadb/lambdadb-python-client/blob/master/#custom-http-client)
+  * [Resource Management](https://github.com/lambdadb/lambdadb-python-client/blob/master/#resource-management)
+  * [Debugging](https://github.com/lambdadb/lambdadb-python-client/blob/master/#debugging)
+* [Development](https://github.com/lambdadb/lambdadb-python-client/blob/master/#development)
+  * [Maturity](https://github.com/lambdadb/lambdadb-python-client/blob/master/#maturity)
+  * [Contributions](https://github.com/lambdadb/lambdadb-python-client/blob/master/#contributions)
 
 <!-- End Table of Contents [toc] -->
 
@@ -96,9 +98,9 @@ It's also possible to write a standalone Python script without needing to set up
 # ]
 # ///
 
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 
-sdk = Lambdadb(
+sdk = LambdaDB(
   # SDK arguments
 )
 
@@ -126,14 +128,14 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 ```python
 # Synchronous Example
-from lambdadb import Lambdadb, models
+from lambdadb import LambdaDB
 
 
-with Lambdadb() as l_client:
+with LambdaDB(
+    project_api_key="<YOUR_PROJECT_API_KEY>",
+) as lambda_db:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = lambda_db.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -145,15 +147,15 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from lambdadb import Lambdadb, models
+from lambdadb import LambdaDB
 
 async def main():
 
-    async with Lambdadb() as l_client:
+    async with LambdaDB(
+        project_api_key="<YOUR_PROJECT_API_KEY>",
+    ) as lambda_db:
 
-        res = await l_client.projects.list_async(security=models.ListProjectsSecurity(
-            admin_api_key="<YOUR_ADMIN_API_KEY>",
-        ))
+        res = await lambda_db.collections.list_async(project_name="<value>")
 
         # Handle response
         print(res)
@@ -175,32 +177,14 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `project_api_key` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 
 
-with Lambdadb(
+with LambdaDB(
     project_api_key="<YOUR_PROJECT_API_KEY>",
-) as l_client:
+) as lambda_db:
 
-    res = l_client.projects.collections.list(project_name="<value>")
-
-    # Handle response
-    print(res)
-
-```
-
-### Per-Operation Security Schemes
-
-Some operations in this SDK require the security scheme to be specified at the request level. For example:
-```python
-from lambdadb import Lambdadb, models
-
-
-with Lambdadb() as l_client:
-
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = lambda_db.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -214,31 +198,23 @@ with Lambdadb() as l_client:
 <details open>
 <summary>Available methods</summary>
 
+### [collections](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md)
 
-### [projects](docs/sdks/projects/README.md)
-
-* [list](docs/sdks/projects/README.md#list) - List all projects in an account.
-* [create](docs/sdks/projects/README.md#create) - Create a project.
-* [get](docs/sdks/projects/README.md#get) - Get metadata of an existing project.
-* [delete](docs/sdks/projects/README.md#delete) - Delete an existing project.
-* [update](docs/sdks/projects/README.md#update) - Configure an existing project
+* [list](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#list) - List all collections in an existing project.
+* [create](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#create) - Create an collection.
+* [delete](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#delete) - Delete an existing collection.
+* [get](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#get) - Get metadata of an existing collection.
+* [update](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#update) - Configure an collection.
+* [query](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/README.md#query) - Search an collection with a query and return the most similar documents.
 
-#### [projects.collections](docs/sdks/collections/README.md)
+#### [collections.docs](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md)
 
-* [list](docs/sdks/collections/README.md#list) - List all collections in an existing project.
-* [create](docs/sdks/collections/README.md#create) - Create an collection.
-* [delete](docs/sdks/collections/README.md#delete) - Delete an existing collection.
-* [get](docs/sdks/collections/README.md#get) - Get metadata of an existing collection.
-* [update](docs/sdks/collections/README.md#update) - Configure an collection.
-* [query](docs/sdks/collections/README.md#query) - Search an collection with a query and return the most similar documents.
+* [upsert](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md#upsert) - Upsert documents into an collection. Note that the maximum supported payload size is 6MB.
+* [get_bulk_upsert](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md#get_bulk_upsert) - Request required info to upload documents.
+* [bulk_upsert](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md#bulk_upsert) - Bulk upsert documents into an collection. Note that the maximum supported object size is 200MB.
+* [delete](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md#delete) - Delete documents by document IDs or query filter from an collection.
+* [fetch](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/docs/README.md#fetch) - Lookup and return documents by document IDs from an collection.
 
-#### [projects.collections.docs](docs/sdks/docs/README.md)
-
-* [upsert](docs/sdks/docs/README.md#upsert) - Upsert documents into an collection. Note that the maximum supported payload size is 6MB.
-* [get_bulk_upsert](docs/sdks/docs/README.md#get_bulk_upsert) - Request required info to upload documents.
-* [bulk_upsert](docs/sdks/docs/README.md#bulk_upsert) - Bulk upsert documents into an collection. Note that the maximum supported object size is 200MB.
-* [delete](docs/sdks/docs/README.md#delete) - Delete documents by document IDs or query filter from an collection.
-* [fetch](docs/sdks/docs/README.md#fetch) - Lookup and return documents by document IDs from an collection.
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -250,15 +226,15 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from lambdadb import Lambdadb, models
+from lambdadb import LambdaDB
 from lambdadb.utils import BackoffStrategy, RetryConfig
 
 
-with Lambdadb() as l_client:
+with LambdaDB(
+    project_api_key="<YOUR_PROJECT_API_KEY>",
+) as lambda_db:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ),
+    res = lambda_db.collections.list(project_name="<value>",
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -268,17 +244,16 @@ with Lambdadb() as l_client:
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from lambdadb import Lambdadb, models
+from lambdadb import LambdaDB
 from lambdadb.utils import BackoffStrategy, RetryConfig
 
 
-with Lambdadb(
+with LambdaDB(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-) as l_client:
+    project_api_key="<YOUR_PROJECT_API_KEY>",
+) as lambda_db:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = lambda_db.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -302,26 +277,27 @@ By default, an API error will raise a errors.APIError exception, which has the f
 
 When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `list_async` method may raise the following exceptions:
 
-| Error Type                  | Status Code | Content Type     |
-| --------------------------- | ----------- | ---------------- |
-| errors.UnauthenticatedError | 401         | application/json |
-| errors.TooManyRequestsError | 429         | application/json |
-| errors.InternalServerError  | 500         | application/json |
-| errors.APIError             | 4XX, 5XX    | \*/\*            |
+| Error Type                   | Status Code | Content Type     |
+| ---------------------------- | ----------- | ---------------- |
+| errors.UnauthenticatedError  | 401         | application/json |
+| errors.ResourceNotFoundError | 404         | application/json |
+| errors.TooManyRequestsError  | 429         | application/json |
+| errors.InternalServerError   | 500         | application/json |
+| errors.APIError              | 4XX, 5XX    | \*/\*            |
 
 ### Example
 
 ```python
-from lambdadb import Lambdadb, errors, models
+from lambdadb import LambdaDB, errors
 
 
-with Lambdadb() as l_client:
+with LambdaDB(
+    project_api_key="<YOUR_PROJECT_API_KEY>",
+) as lambda_db:
     res = None
     try:
 
-        res = l_client.projects.list(security=models.ListProjectsSecurity(
-            admin_api_key="<YOUR_ADMIN_API_KEY>",
-        ))
+        res = lambda_db.collections.list(project_name="<value>")
 
         # Handle response
         print(res)
@@ -329,6 +305,9 @@ with Lambdadb() as l_client:
     except errors.UnauthenticatedError as e:
         # handle e.data: errors.UnauthenticatedErrorData
         raise(e)
+    except errors.ResourceNotFoundError as e:
+        # handle e.data: errors.ResourceNotFoundErrorData
+        raise(e)
     except errors.TooManyRequestsError as e:
         # handle e.data: errors.TooManyRequestsErrorData
         raise(e)
@@ -348,16 +327,15 @@ with Lambdadb() as l_client:
 
 The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
-from lambdadb import Lambdadb, models
+from lambdadb import LambdaDB
 
 
-with Lambdadb(
+with LambdaDB(
     server_url="https://{baseUrl}",
-) as l_client:
+    project_api_key="<YOUR_PROJECT_API_KEY>",
+) as lambda_db:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = lambda_db.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -374,16 +352,16 @@ This allows you to wrap the client with your own custom logic, such as adding cu
 
 For example, you could specify a header for every request that this sdk makes as follows:
 ```python
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
-s = Lambdadb(client=http_client)
+s = LambdaDB(client=http_client)
 ```
 
 or you could wrap the client with your own custom logic:
 ```python
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 from lambdadb.httpclient import AsyncHttpClient
 import httpx
 
@@ -442,29 +420,33 @@ class CustomClient(AsyncHttpClient):
             extensions=extensions,
         )
 
-s = Lambdadb(async_client=CustomClient(httpx.AsyncClient()))
+s = LambdaDB(async_client=CustomClient(httpx.AsyncClient()))
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
 <!-- Start Resource Management [resource-management] -->
 ## Resource Management
 
-The `Lambdadb` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+The `LambdaDB` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
 
 [context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
 
 ```python
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 def main():
 
-    with Lambdadb() as l_client:
+    with LambdaDB(
+        project_api_key="<YOUR_PROJECT_API_KEY>",
+    ) as lambda_db:
         # Rest of application here...
 
 
 # Or when using async:
 async def amain():
 
-    async with Lambdadb() as l_client:
+    async with LambdaDB(
+        project_api_key="<YOUR_PROJECT_API_KEY>",
+    ) as lambda_db:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -476,11 +458,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
 
 You can pass your own logger class directly into your SDK.
 ```python
-from lambdadb import Lambdadb
+from lambdadb import LambdaDB
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = Lambdadb(debug_logger=logging.getLogger("lambdadb"))
+s = LambdaDB(debug_logger=logging.getLogger("lambdadb"))
 ```
 
 You can also enable a default debug logger by setting an environment variable `LAMBDADB_DEBUG` to true.