pyzotero 1.7.1__tar.gz → 1.7.3__tar.gz

{pyzotero-1.7.1 → pyzotero-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyzotero
-Version: 1.7.1
+Version: 1.7.3
 Summary: Python wrapper for the Zotero API
 Keywords: Zotero,DH
 Author: Stephan Hügel
@@ -149,7 +149,7 @@ Use the `--json` flag to output structured JSON.
 
 ## Optional: Command-Line Interface
 
-Pyzotero includes an optional command-line interface for searching and querying your local Zotero library.
+Pyzotero includes an optional command-line interface for searching and querying your local Zotero library. As it uses the local API server introduced in Zotero 7, it requires "Allow other applications on this computer to communicate with Zotero" to be enabled in Zotero's Settings > Advanced.
 
 ### Installing the CLI
 

{pyzotero-1.7.1 → pyzotero-1.7.3}/README.md

@@ -82,7 +82,7 @@ Use the `--json` flag to output structured JSON.
 
 ## Optional: Command-Line Interface
 
-Pyzotero includes an optional command-line interface for searching and querying your local Zotero library.
+Pyzotero includes an optional command-line interface for searching and querying your local Zotero library. As it uses the local API server introduced in Zotero 7, it requires "Allow other applications on this computer to communicate with Zotero" to be enabled in Zotero's Settings > Advanced.
 
 ### Installing the CLI
 

{pyzotero-1.7.1 → pyzotero-1.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyzotero"
-version = "1.7.1"
+version = "1.7.3"
 description = "Python wrapper for the Zotero API"
 readme = "README.md"
 requires-python = ">=3.9"

{pyzotero-1.7.1 → pyzotero-1.7.3}/src/pyzotero/cli.py

@@ -4,8 +4,9 @@ import json
 import sys
 
 import click
+import httpx
 
-from pyzotero import zotero
+from pyzotero import __version__, zotero
 from pyzotero.zotero import chunks
 
 
@@ -15,6 +16,7 @@ def _get_zotero_client(locale="en-US"):
 
 
 @click.group()
+@click.version_option(version=__version__, prog_name="pyzotero")
 @click.option(
     "--locale",
     default="en-US",
@@ -210,7 +212,11 @@ def search(ctx, query, fulltext, itemtype, collection, limit, output_json):  # n
 
         # Output results
         if output_json:
-            click.echo(json.dumps(output_items, indent=2))
+            click.echo(
+                json.dumps(
+                    {"count": len(output_items), "items": output_items}, indent=2
+                )
+            )
         else:
             click.echo(f"\nFound {len(results)} items:\n")
             for idx, item_obj in enumerate(output_items, 1):
@@ -348,5 +354,47 @@ def itemtypes(ctx):
         sys.exit(1)
 
 
+@main.command()
+@click.pass_context
+def test(ctx):
+    """Test connection to local Zotero instance.
+
+    This command checks whether Zotero is running and accepting local connections.
+
+    Examples:
+        pyzotero test
+
+    """
+    try:
+        locale = ctx.obj.get("locale", "en-US")
+        zot = _get_zotero_client(locale)
+
+        # Call settings() to test the connection
+        # This should return {} if Zotero is running and listening
+        result = zot.settings()
+
+        # If we get here, the connection succeeded
+        click.echo("✓ Connection successful: Zotero is running and listening locally.")
+        if result == {}:
+            click.echo("  Received expected empty settings response.")
+        else:
+            click.echo(f"  Received response: {json.dumps(result)}")
+
+    except httpx.ConnectError:
+        click.echo(
+            "✗ Connection failed: Could not connect to Zotero.\n\n"
+            "Possible causes:\n"
+            "  • Zotero might not be running\n"
+            "  • Local connections might not be enabled\n\n"
+            "To enable local connections:\n"
+            "  Zotero > Settings > Advanced > Allow other applications on this computer to communicate with Zotero",
+            err=True,
+        )
+        sys.exit(1)
+    except Exception as e:
+        click.echo(f"Error: {e!s}", err=True)
+        sys.exit(1)
+
+
 if __name__ == "__main__":
     main()