lambdadb 0.1.2__tar.gz → 0.2.0__tar.gz

{lambdadb-0.1.2 → lambdadb-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lambdadb
-Version: 0.1.2
+Version: 0.2.0
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -9,13 +9,15 @@ 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
+# LambdaDB Python SDK
 
-Developer-friendly & type-safe Python SDK specifically catered to leverage *lambdadb* API.
+Developer-friendly & type-safe Python SDK specifically catered to leverage *LambdaDB* API.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=lambdadb&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -24,11 +26,6 @@ Developer-friendly & type-safe Python SDK specifically catered to leverage *lamb
     </a>
 </div>
 
-
-<br /><br />
-> [!IMPORTANT]
-> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/lambdadb/lambdadb-python). Delete this section before > publishing to a package manager.
-
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -38,31 +35,27 @@ LambdaDB API: LambdaDB Open API Spec
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
-* [lambdadb](#lambdadb)
-  * [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] -->
 
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 > [!NOTE]
 > **Python version upgrade policy**
 >
@@ -75,7 +68,7 @@ The SDK can be installed with either *pip* or *poetry* package managers.
 *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
 
 ```bash
-pip install git+<UNSET>.git
+pip install lambdadb
 ```
 
 ### Poetry
@@ -83,7 +76,7 @@ pip install git+<UNSET>.git
 *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
 
 ```bash
-poetry add git+<UNSET>.git
+poetry add lambdadb
 ```
 
 ### Shell and script usage with `uv`
@@ -135,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 l_client:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = l_client.projects.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -154,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 l_client:
 
-        res = await l_client.projects.list_async(security=models.ListProjectsSecurity(
-            admin_api_key="<YOUR_ADMIN_API_KEY>",
-        ))
+        res = await l_client.projects.collections.list_async(project_name="<value>")
 
         # Handle response
         print(res)
@@ -196,24 +189,6 @@ with Lambdadb(
     # 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>",
-    ))
-
-    # Handle response
-    print(res)
-
 ```
 <!-- End Authentication [security] -->
 
@@ -224,30 +199,25 @@ with Lambdadb() as l_client:
 <summary>Available methods</summary>
 
 
-### [projects](docs/sdks/projects/README.md)
+### [projects](https://github.com/lambdadb/lambdadb-python-client/blob/master/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
 
-#### [projects.collections](docs/sdks/collections/README.md)
+#### [projects.collections](https://github.com/lambdadb/lambdadb-python-client/blob/master/docs/sdks/collections/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.
+* [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](docs/sdks/docs/README.md)
+#### [projects.collections.docs](https://github.com/lambdadb/lambdadb-python-client/blob/master/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.
+* [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.
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -259,15 +229,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 l_client:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ),
+    res = l_client.projects.collections.list(project_name="<value>",
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -277,17 +247,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(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
+    project_api_key="<YOUR_PROJECT_API_KEY>",
 ) as l_client:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = l_client.projects.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -311,26 +280,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 l_client:
     res = None
     try:
 
-        res = l_client.projects.list(security=models.ListProjectsSecurity(
-            admin_api_key="<YOUR_ADMIN_API_KEY>",
-        ))
+        res = l_client.projects.collections.list(project_name="<value>")
 
         # Handle response
         print(res)
@@ -338,6 +308,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)
@@ -357,16 +330,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(
     server_url="https://{baseUrl}",
+    project_api_key="<YOUR_PROJECT_API_KEY>",
 ) as l_client:
 
-    res = l_client.projects.list(security=models.ListProjectsSecurity(
-        admin_api_key="<YOUR_ADMIN_API_KEY>",
-    ))
+    res = l_client.projects.collections.list(project_name="<value>")
 
     # Handle response
     print(res)
@@ -466,14 +438,18 @@ The `Lambdadb` class implements the context manager protocol and registers a fin
 from lambdadb import Lambdadb
 def main():
 
-    with Lambdadb() as l_client:
+    with Lambdadb(
+        project_api_key="<YOUR_PROJECT_API_KEY>",
+    ) as l_client:
         # 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 l_client:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -508,7 +484,4 @@ looking for the latest version.
 ## Contributions
 
 While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
-
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=lambdadb&utm_campaign=python)
-
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.