pyzotero 1.7.2__py3-none-any.whl → 1.7.4__py3-none-any.whl

pyzotero/cli.py

@@ -4,6 +4,7 @@ import json
 import sys
 
 import click
+import httpx
 
 from pyzotero import __version__, zotero
 from pyzotero.zotero import chunks
@@ -14,6 +15,29 @@ def _get_zotero_client(locale="en-US"):
     return zotero.Zotero(library_id="0", library_type="user", local=True, locale=locale)
 
 
+def _normalize_doi(doi):
+    """Normalise a DOI for case-insensitive matching.
+
+    Strips common prefixes (https://doi.org/, http://doi.org/, doi:) and converts to lowercase.
+    DOIs are case-insensitive per the DOI specification.
+    """
+    if not doi:
+        return ""
+
+    # Strip whitespace
+    doi = doi.strip()
+
+    # Strip common prefixes
+    prefixes = ["https://doi.org/", "http://doi.org/", "doi:"]
+    for prefix in prefixes:
+        if doi.lower().startswith(prefix.lower()):
+            doi = doi[len(prefix) :]
+            break
+
+    # Convert to lowercase for case-insensitive matching
+    return doi.lower().strip()
+
+
 @click.group()
 @click.version_option(version=__version__, prog_name="pyzotero")
 @click.option(
@@ -353,5 +377,141 @@ 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)
+
+
+@main.command()
+@click.argument("dois", nargs=-1)
+@click.option(
+    "--json",
+    "output_json",
+    is_flag=True,
+    help="Output results as JSON",
+)
+@click.pass_context
+def alldoi(ctx, dois, output_json):  # noqa: PLR0912
+    """Look up DOIs in the local Zotero library and return their Zotero IDs.
+
+    Accepts one or more DOIs as arguments and checks if they exist in the library.
+    DOI matching is case-insensitive and handles common prefixes (https://doi.org/, doi:).
+
+    If no DOIs are provided, shows "No items found" (text) or {} (JSON).
+
+    Examples:
+        pyzotero alldoi 10.1234/example
+
+        pyzotero alldoi 10.1234/abc https://doi.org/10.5678/def doi:10.9012/ghi
+
+        pyzotero alldoi 10.1234/example --json
+
+    """
+    try:
+        locale = ctx.obj.get("locale", "en-US")
+        zot = _get_zotero_client(locale)
+
+        # Build a mapping of normalized DOIs to (original_doi, zotero_key)
+        click.echo("Building DOI index from library...", err=True)
+        doi_map = {}
+
+        # Get all items using everything() which handles pagination automatically
+        all_items = zot.everything(zot.items())
+
+        # Process all items
+        for item in all_items:
+            data = item.get("data", {})
+            item_doi = data.get("DOI", "")
+
+            if item_doi:
+                normalized_doi = _normalize_doi(item_doi)
+                item_key = data.get("key", "")
+
+                if normalized_doi and item_key:
+                    # Store the original DOI from Zotero and the item key
+                    doi_map[normalized_doi] = (item_doi, item_key)
+
+        click.echo(f"Indexed {len(doi_map)} items with DOIs", err=True)
+
+        # If no DOIs provided, return empty result
+        if not dois:
+            if output_json:
+                click.echo(json.dumps({}))
+            else:
+                click.echo("No items found")
+            return
+
+        # Look up each input DOI
+        found = []
+        not_found = []
+
+        for input_doi in dois:
+            normalized_input = _normalize_doi(input_doi)
+
+            if normalized_input in doi_map:
+                original_doi, zotero_key = doi_map[normalized_input]
+                found.append({"doi": original_doi, "key": zotero_key})
+            else:
+                not_found.append(input_doi)
+
+        # Output results
+        if output_json:
+            result = {"found": found, "not_found": not_found}
+            click.echo(json.dumps(result, indent=2))
+        else:
+            if found:
+                click.echo(f"\nFound {len(found)} items:\n")
+                for item in found:
+                    click.echo(f"  {item['doi']} → {item['key']}")
+            else:
+                click.echo("No items found")
+
+            if not_found:
+                click.echo(f"\nNot found ({len(not_found)}):")
+                for doi in not_found:
+                    click.echo(f"  {doi}")
+
+    except Exception as e:
+        click.echo(f"Error: {e!s}", err=True)
+        sys.exit(1)
+
+
 if __name__ == "__main__":
     main()

{pyzotero-1.7.2.dist-info → pyzotero-1.7.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyzotero
-Version: 1.7.2
+Version: 1.7.4
 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.2.dist-info → pyzotero-1.7.4.dist-info}/RECORD

@@ -1,9 +1,9 @@
 pyzotero/__init__.py,sha256=5QI4Jou9L-YJAf_oN9TgRXVKgt_Unc39oADo2Ch8bLI,243
-pyzotero/cli.py,sha256=pMAb9GjwWk-xOs46iZBvoT1o4n0wN8x_PtISwi4zpS4,11208
+pyzotero/cli.py,sha256=dsq4QFqs4vig7CpORQYWD96smM8Z00BbaVh8AsLjhmg,16243
 pyzotero/filetransport.py,sha256=umLik1LLmrpgaNmyjvtBoqqcaMgIq79PYsTvN5vG-gY,5530
 pyzotero/zotero.py,sha256=4qb7jLl1lNkDv3WpEPLW2L0SbleTtGYlQ6Rloz-hmN0,76497
 pyzotero/zotero_errors.py,sha256=6obx9-pBO0z1bxt33vuzDluELvA5kSLCsfc-uGc3KNw,2660
-pyzotero-1.7.2.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-pyzotero-1.7.2.dist-info/entry_points.txt,sha256=MzN7IMRj_oPNmDCsseYFPum3bHWE1gFxywhlbFbcn2k,48
-pyzotero-1.7.2.dist-info/METADATA,sha256=TvDiYLSyFgSFlnp-ja9HkRdsS01nEhX8XE8gXTfwowk,9776
-pyzotero-1.7.2.dist-info/RECORD,,
+pyzotero-1.7.4.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+pyzotero-1.7.4.dist-info/entry_points.txt,sha256=MzN7IMRj_oPNmDCsseYFPum3bHWE1gFxywhlbFbcn2k,48
+pyzotero-1.7.4.dist-info/METADATA,sha256=CplfEb3lWWO75oglunBdtKSiytbEGgrbKSsDfEejOcU,9962
+pyzotero-1.7.4.dist-info/RECORD,,