Merge branch 'main' into lucy/readme-update

Author: libutcher

.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -0,0 +1,36 @@
+name: "🐛 Bug Report"
+description: Something isn't working as expected.
+labels: ["bug"]
+body:
+  - type: textarea
+    id: scenario
+    attributes:
+      label: Scenario & Reproduction Steps
+      description: When do you encounter this problem?
+      placeholder: "Please share as much context as you can about when you encounter this problem. If possible, sharing the steps to reproduce is immensely helpful."
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What is happening?
+      placeholder: "Please tell us about the problem you're encountering. e.g. an error you're encountering or an unexpected return value"
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What would you have expected happened instead?
+      placeholder: "Please share what you had expected to happen. How should this have behaved?"
+  - type: input
+    id: version
+    attributes:
+      label: SDK version
+      description: "You can find the version you're using by running `npm list @1password/sdk`."
+  - type: textarea
+    id: info
+    attributes:
+      label: Additional information
+      description: Any additional information that's relevant to add?

.github/ISSUE_TEMPLATE/2-improvement.yml

@@ -0,0 +1,29 @@
+name: "↗️ Improvement"
+description: Something works but can be made better.
+labels: ["improvement"]
+body:
+  - type: textarea
+    id: current
+    attributes:
+      label: Current Behavior
+      description: How does this currently work?
+      placeholder: "Please tell us what you're currently doing and what hurdles you're running into with this."
+    validations:
+      required: true
+  - type: textarea
+    id: desired
+    attributes:
+      label: Desired Behavior
+      description: How would you prefer for this to work?
+      placeholder: "Please share how you'd prefer for this to work."
+  - type: textarea
+    id: value
+    attributes:
+      label: Benefits & Value
+      description: What is better about the new behavior? How will this help you?
+      placeholder: "Please share what benefits you'd like to get out of this improvement. What would you use this for? How does that improve with this change? Why should this change be made?"
+  - type: textarea
+    id: info
+    attributes:
+      label: Additional information
+      description: Any additional information that's relevant to add?

.github/ISSUE_TEMPLATE/3-feature-request.yml

@@ -0,0 +1,23 @@
+name: "✨ Feature request"
+description: I'd like to request new functionality.
+labels: ["feature-request"]
+body:
+  - type: textarea
+    id: usecase
+    attributes:
+      label: Use Case
+      description: What are you trying to achieve?
+      placeholder: "Tell us about the problem you're trying to solve. The more context you add, the better we can align a solution with your problem."
+    validations:
+      required: true
+  - type: textarea
+    id: requirements
+    attributes:
+      label: Requirements and desired behavior
+      description: What should the SDK do?
+      placeholder: If you already have an idea for what you'd like to be available in the SDK to solve your problem, feel free to share that here. How would you expect this to behave?
+  - type: textarea
+    id: info
+    attributes:
+      label: Additional information
+      description: Any additional information that's relevant to add?

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: "💬 Chat with us on Slack"
+    url: https://developer.1password.com/joinslack
+    about: Chat with us about SDKs in our Developer Slack workspace.
+  - name: "❓ General 1Password questions"
+    url: https://1password.community
+    about: I have a question about 1Password that's not directly related to SDKs.

.github/workflows/check-signed-commits.yml

@@ -0,0 +1,13 @@
+name: Check signed commits in PR 
+on: pull_request_target
+
+jobs:
+  build:
+    name: Check signed commits in PR 
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check signed commits in PR
+        uses: 1Password/check-signed-commits-action@main

.github/workflows/validate.yml

@@ -12,7 +12,10 @@ on:
 jobs:
 
   validate:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
 
@@ -21,17 +24,28 @@ jobs:
         with:
           python-version: '3.x'
 
-      - name: Test with pytest
+      - name: Integration Test
         env:
           OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.TEST_SERVICE_ACCOUNT_TOKEN }}
         run: |
           pip install pytest &&
           pip install pytest-asyncio &&
           pip install pydantic &&
-          python -m pytest src/onepassword/*.py
+          python -m pytest src/onepassword/test_client.py
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Lint with Ruff
         run: |
           pip install ruff
-          ruff --output-format=github --exclude=src/onepassword/lib/ .
+          ruff check --output-format=github --exclude=src/onepassword/lib/,example/ .
         continue-on-error: true

Makefile

@@ -0,0 +1,7 @@
+release:
+	src/release/scripts/release.sh
+
+prep-release:
+	src/release/scripts/prep-release.sh
+
+

README.md

@@ -16,8 +16,14 @@
 
 The 1Password Python SDK offers programmatic access to your secrets in 1Password with Python. During the beta, you can create, retrieve, update, and delete items and resolve secret references.
 
-1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/).
+## Requirements
 
+The 1Password Python SDK requires:
+
+- `libssl` 3
+- `glibc` 2.32 or later
+
+If you're running a Linux distribution that still uses `libssl` version 1.1.1, such as Debian 11 or Ubuntu 20.04, you'll need to update to a later version of Linux or install the required dependencies.
 
 ## ❗ Limitations
 
@@ -49,7 +55,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].5
+   pip install git+ssh://[email protected]/1Password/[email protected].9
    ```
 
 4. Use the Python SDK in your project:
@@ -63,7 +69,7 @@ async def main():
     # Gets your service account token from the OP_SERVICE_ACCOUNT_TOKEN environment variable.
     token = os.getenv("OP_SERVICE_ACCOUNT_TOKEN")
 
-    # Connects to 1Password.
+    # Connects to 1Password. Fill in your own integration name and version.
     client = await Client.authenticate(auth=token, integration_name="My 1Password Integration", integration_version="v1.0.0")
 
     # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
@@ -77,12 +83,8 @@ if __name__ == '__main__':
 
 Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secrets-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
 
-Inside `Client.authenticate(...)`, set `integration_name` to the name of your application and `integration_version` to the version of your application.
-
-
 ## 📖 Learn more
 
 - [Load secrets with 1Password SDKs](https://developer.1password.com/docs/sdks/load-secrets)
 - [Manage items with 1Password SDKs](https://developer.1password.com/docs/sdks/manage-items)
 - [1Password SDK concepts](https://developer.1password.com/docs/sdks/concepts)
-

example/example.py

@@ -1,8 +1,6 @@
 import asyncio
 import os
-from onepassword.client import Client
-from onepassword.types import Item, ItemField, ItemSection
-
+from onepassword import *
 
 async def main():
     # Gets your service account token from the OP_SERVICE_ACCOUNT_TOKEN environment variable.
@@ -11,6 +9,7 @@ async def main():
     # Connects to 1Password.
     client = await Client.authenticate(
         auth=token,
+        # Set the following to your own integration name and version.
         integration_name="My 1Password Integration",
         integration_version="v1.0.0",
     )
@@ -24,7 +23,7 @@ async def main():
         id="",
         title="MyName",
         category="Login",
-        vault_id="vault_id",
+        vault_id="q73bqltug6xoegr3wkk2zkenoq",
         fields=[
             ItemField(
                 id="username",
@@ -48,7 +47,7 @@ async def main():
     print(dict(created_item))
 
     # Retrieve an item from your vault.
-    item = await client.items.get("vault_id", created_item.id)
+    item = await client.items.get(created_item.vault_id, created_item.id)
 
     print(dict(item))
 
@@ -59,7 +58,7 @@ async def main():
     print(dict(updated_item))
 
     # Delete a item from your vault.
-    await client.items.delete("vault_id", updated_item.id)
+    await client.items.delete(created_item.vault_id, updated_item.id)
 
 
 if __name__ == "__main__":

setup.py

@@ -2,6 +2,7 @@
 from sysconfig import get_platform
 import platform
 import os
+from src.release.version import SDK_VERSION
 
 try:
     from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
@@ -20,21 +21,19 @@ def finalize_options(self):
 def get_shared_library_data_to_include():
     # Return the correct uniffi C shared library extension for the given platform
     include_path = "lib"
-    if platform.machine().lower() == "x86_64" or platform.machine().lower() == "amd64":
+    machine_type = platform.machine().lower()
+    if machine_type in ["x86_64", "amd64"]:
         include_path = os.path.join(include_path, "x86_64")
-    elif (
-        platform.machine().lower() == "aarch64" or platform.machine().lower() == "arm64"
-    ):
+    elif machine_type in ["aarch64", "arm64"]:
         include_path = os.path.join(include_path, "aarch64")
 
-    c_shared_library_file_name = ""
-    if platform.system() == "Darwin":
-        c_shared_library_file_name = "libop_uniffi_core.dylib"
-    elif platform.system() == "Linux":
-        c_shared_library_file_name = "libop_uniffi_core.so"
-    elif platform.system() == "Windows":
-        c_shared_library_file_name = "op_uniffi_core.dll"
-
+    # Map current platform to the correct shared library file name
+    platform_to_lib = {
+        "Darwin": "libop_uniffi_core.dylib",
+        "Linux": "libop_uniffi_core.so",
+        "Windows": "op_uniffi_core.dll"
+    }
+    c_shared_library_file_name = platform_to_lib.get(platform.system(), "")
     c_shared_library_file_name = os.path.join(include_path, c_shared_library_file_name)
 
     uniffi_bindings_file_name = "op_uniffi_core.py"
@@ -45,7 +44,7 @@ def get_shared_library_data_to_include():
 
 setup(
     name="onepassword",
-    version="0.1.0-beta.1",
+    version=SDK_VERSION,
     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",