CI Pipeline Runs example/example.py

.github/workflows/validate.yml

@@ -20,6 +20,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ["3.9", "3.10", "3.11", "3.12"]
+      max-parallel: 1
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -35,7 +36,13 @@ jobs:
           pip install pytest-asyncio &&
           pip install pydantic &&
           python -m pytest src/onepassword/test_client.py
-
+      - name: Example Test
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.EXAMPLE_TESTS_OP_SERVICE_ACCOUNT_TOKEN }}
+          OP_VAULT_ID: ${{ secrets.EXAMPLE_TESTS_OP_VAULT_ID }}
+        run: |
+          pip install . &&
+          python example/example.py
   lint:
     name: Lint
     runs-on: ubuntu-latest
@@ -97,6 +104,17 @@ jobs:
     - run: |
         echo "Integration tests completed successfully!"
 
+    - name: Example Test
+      env:
+        OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.TEST_SERVICE_ACCOUNT_TOKEN }}
+        OP_VAULT_ID: ${{ secrets.TEST_SERVICE_ACCOUNT_VAULT_ID }}
+      run: |
+        pip install . &&
+        python example/example.py
+
+    - run: |
+        echo "Example file ran successfully!"
+
     # Update check run called "integration-fork" on the forked PR
     - uses: actions/github-script@v6
       id: update-check-run

example/README.md

@@ -0,0 +1,15 @@
+# Examples
+
+This folder contains a code snippet that demonstrates how to use the 1Password Python SDK to retrieve a secret from 1Password and export it as an environment variable. 
+
+## Prerequisites
+
+1. Clone the repository and follow the steps to [get started](https://github.com/1Password/onepassword-sdk-python/blob/main/README.md).
+2. Make sure to export a valid service account token. For example:
+	```bash
+	export OP_SERVICE_ACCOUNT_TOKEN="<your token>"
+	```
+3. Make sure to export a valid vault uuid. For example:
+    ```bash
+    export OP_VAULT_ID="<your vault uuid>"
+    ```

example/example.py

@@ -40,18 +40,16 @@ async def main():
         print(error)
     # [developer-docs.sdk.python.validate-secret-reference]-end
 
-    # [developer-docs.sdk.python.resolve-secret]-start
-    # 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)
-    # [developer-docs.sdk.python.resolve-secret]-end
+    vault_id= os.getenv("OP_VAULT_ID")
+    if vault_id is None:
+        raise Exception("OP_VAULT_ID environment variable is not set")
 
     # [developer-docs.sdk.python.create-item]-start
     # Create an Item and add it to your vault.
     to_create = ItemCreateParams(
         title="MyName",
         category=ItemCategory.LOGIN,
-        vault_id="7turaasywpymt3jecxoxk5roli",
+        vault_id=vault_id,
         fields=[
             ItemField(
                 id="username",
@@ -91,6 +89,12 @@ async def main():
 
     print(dict(created_item))
 
+    # [developer-docs.sdk.python.resolve-secret]-start
+    # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
+    value = await client.secrets.resolve(f"op://{created_item.vault_id}/{created_item.id}/username")
+    print(value)
+    # [developer-docs.sdk.python.resolve-secret]-end
+
     # [developer-docs.sdk.python.resolve-totp-code]-start
     # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
     code = await client.secrets.resolve(