Merge pull request #91 from 1Password/sdk-core/2024-08-06-d16c23e9

Release v0.1.0-beta.13

Author: AndyTitu

README.md

@@ -57,7 +57,7 @@ To use the 1Password Python SDK in your project:
 3. Install the 1Password Python SDK in your project:
 
    ```bash
-   pip install git+ssh://[email protected]/1Password/[email protected].9
+   pip install git+ssh://[email protected]/1Password/[email protected].13
    ```
 
 4. Use the Python SDK in your project:

example/example.py

@@ -15,6 +15,13 @@ async def main():
         integration_version="v1.0.0",
     )
 
+    vaults = await client.vaults.list_all()
+    async for vault in vaults:
+        print(vault.title)
+        items = await client.items.list_all(vault.id)
+        async for item in items:
+            print(item.title)
+
     # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
     value = await client.secrets.resolve("op://vault/item/field")
     print(value)
@@ -50,7 +57,10 @@ async def main():
                 details=None,
             ),
         ],
-        sections=[ItemSection(id="", title=""), ItemSection(id="totpsection", title="")],
+        sections=[
+            ItemSection(id="", title=""),
+            ItemSection(id="totpsection", title=""),
+        ],
     )
     created_item = await client.items.create(to_create)
 
@@ -64,7 +74,6 @@ async def main():
             else:
                 print(f.details.content.code)
 
-    
     # Retrieve an item from your vault.
     item = await client.items.get(created_item.vault_id, created_item.id)
 

setup.py

@@ -43,7 +43,7 @@ def get_shared_library_data_to_include():
 
 setup(
     name="onepassword",
-    version="0.1.0-beta.12",
+    version="0.1.0-beta.13",
     author="1Password",
     description="The 1Password Python SDK offers programmatic read access to your secrets in 1Password in an interface native to Python.",
     url="https://github.com/1Password/onepassword-sdk-python",

src/onepassword/__init__.py

@@ -4,6 +4,7 @@
 from .types import *  # noqa F403
 from .secrets import Secrets
 from .items import Items
+from .vaults import Vaults
 
 
 import sys
@@ -14,6 +15,7 @@
     "Client",
     "Secrets",
     "Items",
+    "Vaults",
     "DEFAULT_INTEGRATION_NAME",
     "DEFAULT_INTEGRATION_VERSION",
 ]

src/onepassword/client.py

@@ -4,11 +4,13 @@
 from .defaults import new_default_config
 from .secrets import Secrets
 from .items import Items
+from .vaults import Vaults
 
 
 class Client:
     secrets: Secrets
     items: Items
+    vaults: Vaults
 
     @classmethod
     async def authenticate(cls, auth, integration_name, integration_version):
@@ -23,6 +25,7 @@ async def authenticate(cls, auth, integration_name, integration_version):
 
         authenticated_client.secrets = Secrets(client_id)
         authenticated_client.items = Items(client_id)
+        authenticated_client.vaults = Vaults(client_id)
         authenticated_client._finalizer = weakref.finalize(
             cls, _release_client, client_id
         )

src/onepassword/defaults.py

@@ -1,7 +1,7 @@
 import platform
 
 SDK_LANGUAGE = "Python"
-SDK_VERSION = "0010012"
+SDK_VERSION = "0010013"
 DEFAULT_INTEGRATION_NAME = "Unknown"
 DEFAULT_INTEGRATION_VERSION = "Unknown"
 DEFAULT_REQUEST_LIBRARY = "net/http"

src/onepassword/items.py

@@ -1,7 +1,8 @@
 # AUTO-GENERATED
 from .core import _invoke
 from json import loads
-from .types import Item
+from .iterator import SDKIterator
+from .types import Item, ItemOverview
 
 
 class Items:
@@ -20,14 +21,14 @@ async def create(self, params):
             {
                 "clientId": self.client_id,
                 "invocation": {
-                    "name": "Create",
+                    "name": "ItemsCreate",
                     "parameters": {
-                        "params": params.dict(),
+                        "params": params.model_dump(by_alias=True),
                     },
                 },
             }
         )
-        return Item(**loads(response))
+        return Item.model_validate_json(response)
 
     async def get(self, vault_id, item_id):
         """
@@ -37,15 +38,15 @@ async def get(self, vault_id, item_id):
             {
                 "clientId": self.client_id,
                 "invocation": {
-                    "name": "Get",
+                    "name": "ItemsGet",
                     "parameters": {
-                        "vault_id": vault_id,
                         "item_id": item_id,
+                        "vault_id": vault_id,
                     },
                 },
             }
         )
-        return Item(**loads(response))
+        return Item.model_validate_json(response)
 
     async def put(self, item):
         """
@@ -55,14 +56,14 @@ async def put(self, item):
             {
                 "clientId": self.client_id,
                 "invocation": {
-                    "name": "Put",
+                    "name": "ItemsPut",
                     "parameters": {
-                        "item": item.dict(),
+                        "item": item.model_dump(by_alias=True),
                     },
                 },
             }
         )
-        return Item(**loads(response))
+        return Item.model_validate_json(response)
 
     async def delete(self, vault_id, item_id):
         """
@@ -73,11 +74,32 @@ async def delete(self, vault_id, item_id):
             {
                 "clientId": self.client_id,
                 "invocation": {
-                    "name": "Delete",
+                    "name": "ItemsDelete",
                     "parameters": {
-                        "vault_id": vault_id,
                         "item_id": item_id,
+                        "vault_id": vault_id,
                     },
                 },
             }
         )
+
+    async def list_all(self, vault_id):
+        """
+        List all items
+        """
+        response = await _invoke(
+            {
+                "clientId": self.client_id,
+                "invocation": {
+                    "name": "ItemsListAll",
+                    "parameters": {
+                        "vault_id": vault_id,
+                    },
+                },
+            }
+        )
+        response_data = loads(response)
+
+        objects = [ItemOverview.model_validate(data) for data in response_data]
+
+        return SDKIterator(objects)

src/onepassword/iterator.py

@@ -0,0 +1,23 @@
+import asyncio
+from typing import AsyncIterator, Iterable, TypeVar
+
+T = TypeVar("T")
+
+
+class SDKIterator(AsyncIterator[T]):
+    def __init__(self, obj: Iterable[T]):
+        self.obj = obj
+        self.index = 0
+        self.lock = asyncio.Lock()
+
+    def __aiter__(self) -> AsyncIterator[T]:
+        return self
+
+    async def __anext__(self) -> T:
+        async with self.lock:
+            if self.index >= len(self.obj):
+                raise StopAsyncIteration
+
+            next_obj = self.obj[self.index]
+            self.index += 1
+            return next_obj