11# [developer-docs.sdk.python.sdk-import]-start
22from onepassword import *
3+ # [developer-docs.sdk.python.sdk-import]-end
34import asyncio
45import os
56
@@ -10,23 +11,25 @@ async def main():
1011 raise Exception ("OP_VAULT_ID is required" )
1112
1213 # [developer-docs.sdk.python.client-initialization]-start
13- # Connects to the 1Password desktop app.
14+ # Connect to the 1Password desktop app
1415 client = await Client .authenticate (
1516 auth = DesktopAuth (
1617 account_name = "YourAccountNameAsShownInTheDesktopApp" # Set to your 1Password account name as shown at the top left sidebar of the app, or your account UUID.
1718 ),
18- # Set the following to your own integration name and version.
19+ # Set to your own integration name and version
1920 integration_name = "My 1Password Integration" ,
2021 integration_version = "v1.0.0" ,
2122 )
2223
2324 # [developer-docs.sdk.python.list-vaults]-start
25+ # List vaults
2426 vaults = await client .vaults .list ()
2527 for vault in vaults :
2628 print (vault )
2729 # [developer-docs.sdk.python.list-vaults]-end
2830
2931 # [developer-docs.sdk.python.list-items]-start
32+ # List items
3033 overviews = await client .items .list (vault_id )
3134 for overview in overviews :
3235 print (overview .title )
@@ -44,7 +47,7 @@ async def main():
4447
4548async def showcase_vault_operations (client : Client ):
4649 # [developer-docs.sdk.python.create-vault]-start
47- # Create Vault
50+ # Create a vault
4851 vault_create_params = VaultCreateParams (
4952 title = "Python SDK Vault" ,
5053 description = "A description" ,
@@ -54,13 +57,14 @@ async def showcase_vault_operations(client: Client):
5457 print (f"Created vault: { created_vault .id } - { created_vault .title } " )
5558 # [developer-docs.sdk.python.create-vault]-end
5659
57- # [developer-docs.sdk.python.vault-overview]-start
60+ # [developer-docs.sdk.python.get-vault-overview]-start
61+ # Get a vault overview
5862 vault_overview = await client .vaults .get_overview (created_vault .id )
5963 print (vault_overview )
60- # [developer-docs.sdk.python.vault-overview]-end
64+ # [developer-docs.sdk.python.get- vault-overview]-end
6165
6266 # [developer-docs.sdk.python.update-vault]-start
63- # Update Vault
67+ # Update a vault
6468 update_params = VaultUpdateParams (
6569 title = "Python SDK Updated Name" ,
6670 description = "Updated description" ,
@@ -70,7 +74,7 @@ async def showcase_vault_operations(client: Client):
7074 # [developer-docs.sdk.python.update-vault]-end
7175
7276 # [developer-docs.sdk.python.get-vault-details]-start
73- # Get Vault
77+ # Get a vault
7478 get_params = VaultGetParams (
7579 accessors = True ,
7680 )
@@ -80,21 +84,20 @@ async def showcase_vault_operations(client: Client):
8084 # [developer-docs.sdk.python.get-vault-details]-end
8185
8286 # [developer-docs.sdk.python.delete-vault]-start
83- # Delete Vault
87+ # Delete a vault
8488 await client .vaults .delete (created_vault .id )
8589 # [developer-docs.sdk.python.delete-vault]-end
8690
8791 # [developer-docs.sdk.python.list-vault]-start
88- # List Vaults
92+ # List vaults
8993 vaults = await client .vaults .list ()
9094 for vault in vaults :
9195 print (vault .title )
9296 # [developer-docs.sdk.python.list-vault]-end
9397
9498async def showcase_group_permission_operations (client : Client , vault_id : str , group_id : str ):
95-
9699 # [developer-docs.sdk.python.grant-group-permissions]-start
97- # Grant Group Permissions
100+ # Grant group permissions in a vault
98101 await client .vaults .grant_group_permissions (
99102 vault_id = vault_id ,
100103 group_permissions_list = [
@@ -108,7 +111,7 @@ async def showcase_group_permission_operations(client: Client, vault_id: str, gr
108111 # [developer-docs.sdk.python.grant-group-permissions]-end
109112
110113 # [developer-docs.sdk.python.update-group-permissions]-start
111- # Update Group Permissions
114+ # Update group permissions in a vault
112115 await client .vaults .update_group_permissions (
113116 group_permissions_list = [
114117 GroupVaultAccess (
@@ -122,7 +125,7 @@ async def showcase_group_permission_operations(client: Client, vault_id: str, gr
122125 # [developer-docs.sdk.python.update-group-permissions]-start
123126
124127 # [developer-docs.sdk.python.revoke-group-permissions]-start
125- # Revoke Group Permissions
128+ # Revoke a group's permissions in a vault
126129 await client .vaults .revoke_group_permissions (
127130 vault_id = vault_id ,
128131 group_id = group_id ,
@@ -180,7 +183,7 @@ async def showcase_batch_item_operations(client: Client, vault_id: str):
180183 )
181184 )
182185
183- # Create all items in the same vault in a single batch
186+ # Batch create all items in the same vault
184187 batchCreateResponse = await client .items .create_all (vault_id , items_to_create )
185188
186189 item_ids = []
@@ -193,7 +196,7 @@ async def showcase_batch_item_operations(client: Client, vault_id: str):
193196 # [developer-docs.sdk.python.batch-create-items]-end
194197
195198 # [developer-docs.sdk.python.batch-get-items]-start
196- # Get multiple items form the same vault in a single batch
199+ # Get multiple items from the same vault
197200 batchGetReponse = await client .items .get_all (vault_id , item_ids )
198201 for res in batchGetReponse .individual_responses :
199202 if res .content is not None :
@@ -203,7 +206,7 @@ async def showcase_batch_item_operations(client: Client, vault_id: str):
203206 # [developer-docs.sdk.python.batch-get-items]-end
204207
205208 # [developer-docs.sdk.python.batch-delete-items]-start
206- # Delete multiple items from the same vault in a single batch
209+ # Delete multiple items from the same vault
207210 batchDeleteResponse = await client .items .delete_all (vault_id , item_ids )
208211 for id , res in batchDeleteResponse .individual_responses .items ():
209212 if res .error is not None :
0 commit comments