Merge main

Author: AndyTitu

.github/workflows/validate.yml

@@ -51,7 +51,7 @@ jobs:
       - 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/ .
         continue-on-error: true
 
   # This action is called by the /ok-to-test command, once the forked PR's code has been security reviewed.

README.md

@@ -51,7 +51,7 @@ To use the 1Password Python SDK in your project:
 2. Install the 1Password Python SDK in your project:
 
    ```bash
-   pip install git+ssh://[email protected]/1Password/[email protected].7
+   pip install git+ssh://[email protected]/1Password/[email protected].9
    ```
 
 3. Use the Python SDK in your project:
@@ -65,7 +65,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.
@@ -79,8 +79,6 @@ 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)

example/example.py

@@ -11,6 +11,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",
     )

setup.py

@@ -20,21 +20,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 +43,7 @@ def get_shared_library_data_to_include():
 
 setup(
     name="onepassword",
-    version="0.1.0-beta.1",
+    version="0.1.0-beta.10",
     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/core.py

@@ -2,16 +2,14 @@
 import platform
 
 
-if platform.machine().lower() == "x86_64" or platform.machine().lower() == "amd64":
+machine_arch = platform.machine().lower()
+
+if machine_arch in ["x86_64", "amd64"]:
     import onepassword.lib.x86_64.op_uniffi_core as core
-elif platform.machine().lower() == "aarch64" or platform.machine().lower() == "arm64":
+elif machine_arch in ["aarch64", "arm64"]:
     import onepassword.lib.aarch64.op_uniffi_core as core
 else:
-    raise ImportError(
-        "your machine's architecture is not currently supported: {}".format(
-            platform.machine()
-        )
-    )
+    raise ImportError(f"Your machine's architecture is not currently supported: {machine_arch}")
 
 
 # InitClient creates a client instance in the current core module and returns its unique ID.

src/onepassword/defaults.py

@@ -1,7 +1,7 @@
 import platform
 
 SDK_LANGUAGE = "Python"
-SDK_VERSION = "0010001"  # v0.1.0
+SDK_VERSION = "0010010"  # v0.1.0-beta.10
 DEFAULT_INTEGRATION_NAME = "Unknown"
 DEFAULT_INTEGRATION_VERSION = "Unknown"
 DEFAULT_REQUEST_LIBRARY = "net/http"

src/onepassword/items.py

@@ -43,7 +43,7 @@ async def get(self, vault_id, item_id):
         return result
 
     async def update(self, item):
-        """Update an existing item. Warning: Only text and concealed fields are currently supported. Other fields will be permanently lost when you update an item."""
+        """Update an existing item. You can currently only edit text and concealed fields."""
         response = await _invoke(
             {
                 "clientId": self.client_id,
@@ -59,7 +59,7 @@ async def update(self, item):
         return result
 
     async def delete(self, vault_id, item_id):
-        """Delete an item. Warning:  Information saved in fields other than text and concealed fields will be permanently lost."""
+        """Delete an item. """
         await _invoke(
             {
                 "clientId": self.client_id,