easybib 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

easybib/cli.py

@@ -1,9 +1,11 @@
 """Command-line interface for easybib."""
 
+import configparser
 import os
 import argparse
 from pathlib import Path
 
+from easybib import __version__
 from easybib.core import (
     extract_cite_keys,
     extract_existing_bib_keys,
@@ -13,11 +15,52 @@ from easybib.core import (
 )
 
 
+def load_config(config_path):
+    """Read an INI config file and return a dict from the [easybib] section."""
+    path = Path(config_path).expanduser()
+    if not path.is_file():
+        return {}
+    config = configparser.ConfigParser()
+    config.read(path)
+    if "easybib" not in config:
+        return {}
+    return dict(config["easybib"])
+
+
 def main():
+    # First pass: extract --config so we know which config file to load
+    pre_parser = argparse.ArgumentParser(add_help=False)
+    pre_parser.add_argument(
+        "--config",
+        default="~/.easybib.config",
+        help="Path to config file (default: ~/.easybib.config)",
+    )
+    pre_args, _ = pre_parser.parse_known_args()
+
+    # Load config and build defaults
+    cfg = load_config(pre_args.config)
+    config_defaults = {}
+    if "output" in cfg:
+        config_defaults["output"] = cfg["output"]
+    if "max-authors" in cfg:
+        config_defaults["max_authors"] = int(cfg["max-authors"])
+    if "preferred-source" in cfg:
+        config_defaults["preferred_source"] = cfg["preferred-source"]
+    if "ads-api-key" in cfg:
+        config_defaults["ads_api_key"] = cfg["ads-api-key"]
+
     parser = argparse.ArgumentParser(
         description="Extract citations and download BibTeX from NASA/ADS"
     )
+    parser.add_argument(
+        "--version", action="version", version=f"%(prog)s {__version__}"
+    )
     parser.add_argument("path", help="LaTeX file or directory containing LaTeX files")
+    parser.add_argument(
+        "--config",
+        default="~/.easybib.config",
+        help="Path to config file (default: ~/.easybib.config)",
+    )
     parser.add_argument(
         "-o", "--output", default="references.bib", help="Output BibTeX file (existing entries are retained)"
     )
@@ -41,7 +84,7 @@ def main():
     )
     parser.add_argument(
         "-s",
-        "--source",
+        "--preferred-source",
         choices=["ads", "inspire", "auto"],
         default="ads",
         help="Preferred BibTeX source: 'ads' (default), 'inspire', or 'auto' (based on key format)",
@@ -50,6 +93,11 @@ def main():
         "--ads-api-key",
         help="ADS API key (overrides ADS_API_KEY environment variable)",
     )
+
+    # Apply config file defaults (CLI flags will still override)
+    if config_defaults:
+        parser.set_defaults(**config_defaults)
+
     args = parser.parse_args()
 
     # Collect all citation keys
@@ -80,12 +128,12 @@ def main():
             print(key)
         return 0
 
-    # Check for ADS API key (not required if using --source inspire)
+    # Check for ADS API key (not required if using --preferred-source inspire)
     api_key = args.ads_api_key or os.getenv("ADS_API_KEY")
-    if not api_key and args.source != "inspire":
+    if not api_key and args.preferred_source != "inspire":
         print("Error: ADS_API_KEY environment variable not set")
         print("Get your API key from: https://ui.adsabs.harvard.edu/user/settings/token")
-        print("(Or use --source inspire to fetch from INSPIRE without an ADS key)")
+        print("(Or use --preferred-source inspire to fetch from INSPIRE without an ADS key)")
         return 1
 
     # Check for existing bib file and determine which keys to fetch
@@ -108,7 +156,7 @@ def main():
     not_found = []
     for key in sorted(keys_to_fetch):
         print(f"Fetching {key}...", end=" ")
-        bibtex, source = fetch_bibtex(key, api_key, args.source)
+        bibtex, source = fetch_bibtex(key, api_key, args.preferred_source)
         if bibtex:
             bibtex = replace_bibtex_key(bibtex, key)
             bibtex = truncate_authors(bibtex, args.max_authors)

{easybib-0.2.0.dist-info → easybib-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easybib
-Version: 0.2.0
+Version: 0.3.0
 Summary: Automatically fetch BibTeX entries from INSPIRE and ADS for LaTeX projects
 Author-email: Gregory Ashton <gregory.ashton@ligo.org>
 License-Expression: MIT
@@ -42,17 +42,18 @@ Pass a directory to scan all `.tex` files recursively, or a single `.tex` file.
 | Flag | Description |
 |------|-------------|
 | `-o`, `--output` | Output BibTeX file (default: `references.bib`) |
-| `-s`, `--source` | Preferred source: `ads` (default), `inspire`, or `auto` |
+| `-s`, `--preferred-source` | Preferred source: `ads` (default), `inspire`, or `auto` |
 | `-a`, `--max-authors` | Truncate author lists (default: 3, use 0 for no limit) |
 | `-l`, `--list-keys` | List found citation keys and exit (no fetching) |
 | `--fresh` | Ignore existing output file and start from scratch |
 | `--ads-api-key` | ADS API key (overrides `ADS_API_KEY` environment variable) |
+| `--config` | Path to config file (default: `~/.easybib.config`) |
 
 ### Examples
 
 ```bash
 # Scan a directory
-easybib ./paper -s inspire
+easybib ./paper --preferred-source inspire
 
 # Scan a single file
 easybib paper.tex
@@ -67,6 +68,34 @@ easybib ./paper -l
 easybib ./paper -a 0
 ```
 
+### Config file
+
+You can create a config file at `~/.easybib.config` to set persistent defaults, so you don't have to pass the same flags every time:
+
+```ini
+[easybib]
+output = references.bib
+max-authors = 3
+preferred-source = ads
+ads-api-key = your-key-here
+```
+
+All fields are optional. CLI flags override config file values, which override the built-in defaults.
+
+To use a config file at a different location:
+
+```bash
+easybib ./paper --config /path/to/my.config
+```
+
+### Source selection
+
+The `--preferred-source` flag controls where BibTeX entries are fetched from. The source determines which service provides the BibTeX data, regardless of the key format used in your `.tex` files.
+
+- **`ads`** (default) — Fetches BibTeX from ADS. If you use an INSPIRE-style key (e.g. `Author:2020abc`), easybib will cross-reference it via INSPIRE to find the corresponding ADS record, then pull the BibTeX from ADS. Falls back to INSPIRE if ADS lookup fails.
+- **`inspire`** — Fetches BibTeX from INSPIRE. Falls back to ADS if the INSPIRE lookup fails. Does not require an ADS API key unless the fallback is triggered.
+- **`auto`** — Chooses the source based on the key format: ADS bibcodes (e.g. `2016PhRvL.116f1102A`) are fetched from ADS, while INSPIRE-style keys are fetched from INSPIRE. Falls back to the other source if the preferred one fails.
+
 ### ADS API key
 
 When using ADS as the source (the default), provide your API key either via the command line:

easybib-0.3.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+easybib/__init__.py,sha256=zCCoB5obi_21h_a_5LK-Zr4G3VkO6XF6Yft5J8pqruU,721
+easybib/__main__.py,sha256=91xpHXOEBRWH-6SL2xquZoAsyDHasxiEPpCK62izpnU,90
+easybib/cli.py,sha256=Klf-LDAyOWTG8YPWt7l2n2syZQ6MhKQ1gHFF7dKtGcU,6172
+easybib/core.py,sha256=OvXeVF_jV3FZlrdtcztxlbU4tCnN0Voei3luJPe3V_8,10066
+easybib-0.3.0.dist-info/METADATA,sha256=AcjxKqd8nOU6xjc1uS6eZ-3Py_Pb_5Mijo_6Qem_IUQ,4428
+easybib-0.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+easybib-0.3.0.dist-info/entry_points.txt,sha256=IHBiLzF5bW19fQOGvK3e1LKnGcYIL81icdGsvrvZ_Zs,45
+easybib-0.3.0.dist-info/top_level.txt,sha256=Xi0IA9fNmv68UPp2bZCEEIXiQYQy0NweD0J9iqZ-LdQ,8
+easybib-0.3.0.dist-info/RECORD,,

easybib-0.2.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-easybib/__init__.py,sha256=zCCoB5obi_21h_a_5LK-Zr4G3VkO6XF6Yft5J8pqruU,721
-easybib/__main__.py,sha256=91xpHXOEBRWH-6SL2xquZoAsyDHasxiEPpCK62izpnU,90
-easybib/cli.py,sha256=IBfiZaBgw_-ZqFiY_XzAeODipRdP6XnQJKyFkFRYFXo,4530
-easybib/core.py,sha256=OvXeVF_jV3FZlrdtcztxlbU4tCnN0Voei3luJPe3V_8,10066
-easybib-0.2.0.dist-info/METADATA,sha256=w9_tKSHjtc47nOBgNsDC8PK-6w1XURiHzGRh_Tm6uTY,2982
-easybib-0.2.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-easybib-0.2.0.dist-info/entry_points.txt,sha256=IHBiLzF5bW19fQOGvK3e1LKnGcYIL81icdGsvrvZ_Zs,45
-easybib-0.2.0.dist-info/top_level.txt,sha256=Xi0IA9fNmv68UPp2bZCEEIXiQYQy0NweD0J9iqZ-LdQ,8
-easybib-0.2.0.dist-info/RECORD,,