@@ -11,23 +11,25 @@ async def main():
1111 raise Exception ("OP_VAULT_ID is required" )
1212
1313 # [developer-docs.sdk.python.client-initialization]-start
14- # Connects to the 1Password desktop app.
14+ # Connect to the 1Password desktop app
1515 client = await Client .authenticate (
1616 auth = DesktopAuth (
1717 account_name = "YourAccountNameAsShownInTheDesktopApp" # Set to your 1Password account name as shown at the top left sidebar of the app, or your account UUID.
1818 ),
19- # Set the following to your own integration name and version.
19+ # Set to your own integration name and version
2020 integration_name = "My 1Password Integration" ,
2121 integration_version = "v1.0.0" ,
2222 )
2323
2424 # [developer-docs.sdk.python.list-vaults]-start
25+ # List vaults
2526 vaults = await client .vaults .list ()
2627 for vault in vaults :
2728 print (vault )
2829 # [developer-docs.sdk.python.list-vaults]-end
2930
3031 # [developer-docs.sdk.python.list-items]-start
32+ # List items
3133 overviews = await client .items .list (vault_id )
3234 for overview in overviews :
3335 print (overview .title )
@@ -45,7 +47,7 @@ async def main():
4547
4648async def showcase_vault_operations (client : Client ):
4749 # [developer-docs.sdk.python.create-vault]-start
48- # Create Vault
50+ # Create a vault
4951 vault_create_params = VaultCreateParams (
5052 title = "Python SDK Vault" ,
5153 description = "A description" ,
@@ -56,12 +58,13 @@ async def showcase_vault_operations(client: Client):
5658 # [developer-docs.sdk.python.create-vault]-end
5759
5860 # [developer-docs.sdk.python.vault-overview]-start
61+ # Get a vault overview
5962 vault_overview = await client .vaults .get_overview (created_vault .id )
6063 print (vault_overview )
6164 # [developer-docs.sdk.python.vault-overview]-end
6265
6366 # [developer-docs.sdk.python.update-vault]-start
64- # Update Vault
67+ # Update a vault
6568 update_params = VaultUpdateParams (
6669 title = "Python SDK Updated Name" ,
6770 description = "Updated description" ,
@@ -71,7 +74,7 @@ async def showcase_vault_operations(client: Client):
7174 # [developer-docs.sdk.python.update-vault]-end
7275
7376 # [developer-docs.sdk.python.get-vault-details]-start
74- # Get Vault
77+ # Get a vault
7578 get_params = VaultGetParams (
7679 accessors = True ,
7780 )
@@ -81,20 +84,20 @@ async def showcase_vault_operations(client: Client):
8184 # [developer-docs.sdk.python.get-vault-details]-end
8285
8386 # [developer-docs.sdk.python.delete-vault]-start
84- # Delete Vault
87+ # Delete a vault
8588 await client .vaults .delete (created_vault .id )
8689 # [developer-docs.sdk.python.delete-vault]-end
8790
8891 # [developer-docs.sdk.python.list-vault]-start
89- # List Vaults
92+ # List vaults
9093 vaults = await client .vaults .list ()
9194 for vault in vaults :
9295 print (vault .title )
9396 # [developer-docs.sdk.python.list-vault]-end
9497
9598async def showcase_group_permission_operations (client : Client , vault_id : str , group_id : str ):
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