papers-cli 2.7.2__py3-none-any.whl → 2.9__py3-none-any.whl

papers/__main__.py

@@ -16,11 +16,11 @@ import papers
 from papers import logger
 from papers.extract import extract_pdf_doi, isvaliddoi, extract_pdf_metadata
 from papers.extract import fetch_bibtex_by_doi
-from papers.encoding import parse_file, format_file, family_names, format_entries, standard_name
+from papers.encoding import parse_file, format_file, family_names, format_entries, standard_name, format_entry, parse_keywords, format_key
 from papers.config import bcolors, Config, search_config, CONFIG_FILE, CONFIG_FILE_LOCAL, DATA_DIR, CONFIG_FILE_LEGACY, BACKUP_DIR
 from papers.duplicate import list_duplicates, list_uniques, edit_entries
 from papers.bib import Biblio, FUZZY_RATIO, DEFAULT_SIMILARITY, entry_filecheck, backupfile as backupfile_func, isvalidkey
-from papers.utils import move, checksum, ansi_link as link, view_pdf
+from papers.utils import move, checksum, view_pdf, open_folder
 from papers import __version__
 
 
@@ -233,7 +233,27 @@ def savebib(biblio, config):
         # config.gitcommit()
 
 
+
+def is_subdirectory(parent, child):
+    # Resolve paths to absolute paths
+    parent = Path(parent).resolve()
+    child = Path(child).resolve()
+
+    # Check if the child path is relative to the parent path
+    return parent in child.parents
+
+
 def view_entry_files(biblio, entry):
+    files = biblio.get_files(entry)
+
+    # in case several attachments are present and the files are ordered under filesdir,
+    # open the subfolder instead of the single files
+    if len(files) > 1:
+        parent = os.path.commonpath(files)
+        if is_subdirectory(biblio.filesdir, parent):
+            open_folder(parent)
+            return
+
     for f in biblio.get_files(entry):
         logger.info(f"opening {f} ...")
         view_pdf(f)
@@ -801,15 +821,6 @@ def listcmd(parser, o, config):
         eq = lambda a, b: a['ID'] == b['ID'] or are_duplicates(a, b, similarity="PARTIAL", fuzzy_ratio=o.fuzzy_ratio)
         entries = list_dup(entries, eq=eq)
 
-    if o.no_key:
-        key = lambda e: ''
-    else:
-        # key = lambda e: bcolors.OKBLUE+e['ID']+filetag(e)+':'+bcolors.ENDC
-        key = lambda e: _nfiles(e)*(bcolors.BOLD)+bcolors.OKBLUE+e['ID']+':'+bcolors.ENDC
-
-    def parse_keywords(e):
-        return [w.strip() for w in e.get('keywords', '').split(',') if w.strip()]
-
     if o.add_keywords:
         for e in entries:
             keywords = parse_keywords(e)
@@ -861,27 +872,13 @@ def listcmd(parser, o, config):
     elif o.field:
         # entries = [{k:e[k] for k in e if k in o.field+['ID','ENTRYTYPE']} for e in entries]
         for e in entries:
-            print(key(e),*[e.get(k, "") for k in o.field])
+            print(format_key(e, no_key=o.no_key),*[e.get(k, "") for k in o.field])
     elif o.key_only:
         for e in entries:
             print(e['ID'])
     elif o.one_liner:
         for e in entries:
-            tit = e.get('title', '')[:60]+ ('...' if len(e.get('title', ''))>60 else '')
-            info = []
-            if e.get('doi',''):
-                info.append(link(f"https://doi.org/{e['doi']}", 'doi:'+e['doi']))
-            n = _nfiles(e)
-            if n:
-                files = parse_file(e.get('file',''), relative_to=biblio.relative_to)
-                file_link = f"file:///{Path(files[0]).resolve()}"
-                ansi_link = link(file_link, f'{"file" if n == 1 else "files"}:{str(n)}')
-                info.append(bcolors.OKGREEN+ansi_link+bcolors.ENDC)
-            if e.get('keywords',''):
-                keywords = parse_keywords(e)
-                info.append(bcolors.WARNING+" | ".join(keywords)+bcolors.ENDC)
-            infotag = '('+', '.join(info)+')' if info else ''
-            print(key(e), tit, infotag)
+            print(format_entry(biblio, e, no_key=o.no_key))
 
     else:
         print(format_entries(entries))
@@ -1147,6 +1144,7 @@ def get_parser(config=None):
 
     grp = listp.add_argument_group('formatting')
     mgrp = grp.add_mutually_exclusive_group()
+    mgrp.add_argument('--plain', action='store_false', dest="one_liner", help='print in bibtex format')
     mgrp.add_argument('-l', '-1', '--one-liner', action='store_true', help='one liner')
     mgrp.add_argument('--key-only', action='store_true')
     mgrp.add_argument('-f', '--field', nargs='+', help='specific field(s) only')

papers/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.7.2'
-__version_tuple__ = version_tuple = (2, 7, 2)
+__version__ = version = '2.9'
+__version_tuple__ = version_tuple = (2, 9)

papers/bib.py

@@ -19,7 +19,7 @@ from papers.extract import extract_pdf_metadata
 from papers.extract import fetch_bibtex_by_fulltext_crossref, fetch_bibtex_by_doi
 
 from papers.encoding import unicode_to_latex, unicode_to_ascii
-from papers.encoding import parse_file, format_file, standard_name, family_names, format_entries, update_file_path
+from papers.encoding import parse_file, format_file, standard_name, family_names, format_entries, update_file_path, format_entry
 
 from papers.filename import NAMEFORMAT, KEYFORMAT
 from papers.utils import bcolors, checksum, move as _move
@@ -298,14 +298,14 @@ class Biblio:
                 newkey = self.append_abc_to_key(entry)  # add abc
                 logger.info('update key: {} => {}'.format(entry['ID'], newkey))
                 entry['ID'] = newkey
-                print("Updated entry:", self.key(entry))
+                print(format_entry(self, entry, prefix="Updated"))
 
             else:
                 raise DuplicateKeyError('this error can be avoided if update_key is True')
 
         else:
             logger.info('new entry: '+self.key(entry))
-            print("New entry:", self.key(entry))
+            print(format_entry(self, entry, prefix="Added"))
 
         self.entries.insert(i, entry)
 
@@ -335,7 +335,7 @@ class Biblio:
             if entry == candidate:
                 logger.debug('exact duplicate')
                 if rename: self.rename_entry_files(candidate, copy=copy)
-                print("Existing entry:", self.key(entry))
+                print(format_entry(self, entry, prefix="Existing"))
                 return [ entry ] # do nothing
 
             if update_key and entry['ID'] != candidate['ID']:
@@ -354,7 +354,7 @@ class Biblio:
                 logger.debug('fixed: exact duplicate')
                 entry = candidate
                 if rename: self.rename_entry_files(candidate, copy=copy)
-                print("Existing entry:", self.key(entry))
+                print(format_entry(self, entry, prefix="Existing"))
                 return [ entry ] # do nothing
 
             logger.debug('conflict resolution: '+on_conflict)

papers/encoding.py

@@ -1,7 +1,9 @@
 import os
 import bibtexparser
+from pathlib import Path
 from unidecode import unidecode as unicode_to_ascii
 from papers.latexenc import unicode_to_latex
+from papers.utils import ansi_link as link, bcolors
 from papers import logger
 
 # fix bibtexparser call on empty strings
@@ -89,6 +91,45 @@ def format_entries(entries):
     db.entries.extend(entries)
     return bibtexparser.dumps(db)
 
+def parse_keywords(e):
+    return [w.strip() for w in e.get('keywords', '').split(',') if w.strip()]
+
+def format_key(e, no_key=False):
+    if no_key:
+        key = lambda e: ''
+    else:
+        n = len(parse_file(e.get('file','')))
+        key = lambda e: n*(bcolors.BOLD)+bcolors.OKBLUE+e['ID']+':'+bcolors.ENDC
+    return key(e)
+
+def format_entry(biblio, e, no_key=False, prefix=""):
+    """One-liner formatter
+    """
+    tit = e.get('title', '')[:60]+ ('...' if len(e.get('title', ''))>60 else '')
+    info = []
+    if e.get('doi',''):
+        info.append(link(f"https://doi.org/{e['doi']}", 'doi:'+e['doi']))
+
+    files = parse_file(e.get('file',''), relative_to=biblio.relative_to)
+    n = len(files)
+
+    if n:
+        file_link = f"file:///{Path(files[0]).resolve()}" if n == 1 else f"file:///{Path(os.path.commonpath(files)).resolve()}"
+        ansi_link = link(file_link, f'{"file" if n == 1 else "files"}:{str(n)}')
+        info.append(bcolors.OKGREEN+ansi_link+bcolors.ENDC)
+
+    if e.get('keywords',''):
+        keywords = parse_keywords(e)
+        info.append(bcolors.WARNING+" | ".join(keywords)+bcolors.ENDC)
+
+    infotag = '('+', '.join(info)+')' if info else ''
+    if prefix:
+        prefixtag = f"{bcolors.WARNING}{prefix} -> {bcolors.ENDC}"
+    else:
+        prefixtag = ""
+    return f"{prefixtag}{format_key(e, no_key=no_key)} {tit} {infotag}"
+
+
 # Parse name entry
 # ================
 

papers/utils.py

@@ -2,7 +2,7 @@ import os
 import re
 import shutil
 import hashlib
-
+import subprocess, platform
 from contextlib import contextmanager
 from pathlib import Path
 
@@ -191,10 +191,22 @@ def view_pdf(filepath):
     """
     https://stackoverflow.com/questions/434597/open-document-with-default-os-application-in-python-both-in-windows-and-mac-os
     """
-    import subprocess, os, platform
     if platform.system() == 'Darwin':       # macOS
         subprocess.call(('open', filepath))
     elif platform.system() == 'Windows':    # Windows
         os.startfile(filepath)
     else:                                   # linux variants
-        subprocess.call(('xdg-open', filepath))
+        subprocess.call(('xdg-open', filepath))
+
+
+def open_folder(path):
+    system_platform = platform.system()
+
+    if system_platform == "Windows":
+        os.startfile(path)
+    elif system_platform == "Darwin":  # macOS
+        os.system(f'open "{path}"')
+    elif system_platform == "Linux":
+        os.system(f'xdg-open "{path}"')
+    else:
+        print("Unsupported operating system.")

{papers_cli-2.7.2.dist-info → papers_cli-2.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.7.2
+Version: 2.9
 Summary: utilities to keep your PDF library organized
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT
@@ -17,7 +17,7 @@ Requires-Dist: scholarly
 Requires-Dist: rapidfuzz
 Requires-Dist: normality
 
-[![test](https://github.com/perrette/papers/workflows/CI/badge.svg)](https://github.com/perrette/papers/actions)
+[![test](https://github.com/perrette/papers/workflows/CI/badge.svg?branch=main)](https://github.com/perrette/papers/actions)
 [![python](https://img.shields.io/badge/python-3.9-blue.svg)]()
 [![python](https://img.shields.io/badge/python-3.10-blue.svg)]()
 [![python](https://img.shields.io/badge/python-3.11-blue.svg)]()
@@ -121,25 +121,25 @@ Some old files don't have a DOI. Best is to add the entry from its bibtex:
 
 ### List entries (and edit etc...)
 
-Pretty listing (-1 or -l for one-liner listing, otherwise plain bibtex):
+Pretty listing by default (otherwise pass --plain for plain bibtex):
 
-    $> papers list -1
+    $> papers list
     Perrette2013: A scaling approach to project regional sea level rise and it... (doi:10.5194/esd-4-11-2013, file:1)
 
 Search with any number of keywords:
 
-    $> papers list perrette scaling approach sea level -1
+    $> papers list perrette scaling approach sea level
     ... (short list)
-    $> papers list perrette scaling approach sea level --any -1
+    $> papers list perrette scaling approach sea level --any
     ... (long list)
-    $> papers list --key perrette2013 --author perrette --year 2013 --title scaling approach sea level -1
+    $> papers list --key perrette2013 --author perrette --year 2013 --title scaling approach sea level
     ... (precise list)
 
 Add tags to view papers by topic:
 
-    $> papers list perrette2013 --add-tag sea-level projections -1
+    $> papers list perrette2013 --add-tag sea-level projections
     ...
-    $> papers list --tag sea-level projections -1
+    $> papers list --tag sea-level projections
     Perrette2013: A scaling approach to project regional sea level rise and it... (doi:10.5194/esd-4-11-2013, file:1, sea-level | projections )
 
 `papers list` is a powerful command, inspired from unix's `find` and `grep`.

papers_cli-2.9.dist-info/RECORD

@@ -0,0 +1,17 @@
+papers/__init__.py,sha256=gEfqa4nhhKYjbk9g07WpJuzU5iAeEHFRGUSvA4VXm8k,108
+papers/__main__.py,sha256=3Ly_JNajRA3H4FPx6JDdyPgmWn930EBO7mzkqKSfjBE,56936
+papers/_version.py,sha256=kerpau_VRaLumk1H9Bkb0gPPzn5FlTh1lEgD7R2rfnk,406
+papers/bib.py,sha256=JSPzIlahE3pqyxbdpxMGvOZTWQYRF9SSDaifIfmbS9I,29817
+papers/config.py,sha256=ufLMp0rBP62bEtesh1s7DZ3FsY4v9Ys669JBua4K_HU,9761
+papers/duplicate.py,sha256=AgGh3QHgE1ZqqqAm8_j13Ao3T-1K-Qe6O8tC4Cyw4DQ,18723
+papers/encoding.py,sha256=5I6v2rK0XQN_xqzpv9dHmRTqObRdyyoWLY2DAlS1ElM,5376
+papers/extract.py,sha256=-RJ8N_AMimjL3jp91txpL7E2vUhEAO-QlT-XssxjqAM,11757
+papers/filename.py,sha256=1uuVnbNkpRogALvDnsy2THfxAuQ2kTH2vlgpfEzsKoI,4744
+papers/latexenc.py,sha256=qH03t6yVUnGZvkZT2-9OWXU-iHqZvVthhQopaM281D4,98127
+papers/utils.py,sha256=DYFufF2YbcBZAIl9uoqtTB-yHzH4A467xC9kuxoMAFE,5502
+papers_cli-2.9.dist-info/LICENSE,sha256=Uc7FclCyMqKU9cc366vVpOLy9gU2w5btUJX9EDzQVIw,1071
+papers_cli-2.9.dist-info/METADATA,sha256=wkg_oIB9KLopnp_ypppm-u6EzTaJJww7se2IxEJOYQ4,18313
+papers_cli-2.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+papers_cli-2.9.dist-info/entry_points.txt,sha256=E1H8yJ7ieFOJT8rLGPQOQB7I1KbqTrcjze3FPfgk8uI,59
+papers_cli-2.9.dist-info/top_level.txt,sha256=sLdcLzjapCbtCY-yXhtEHZEniJB7I35rxRLLLURc8mo,7
+papers_cli-2.9.dist-info/RECORD,,

papers_cli-2.7.2.dist-info/RECORD

@@ -1,17 +0,0 @@
-papers/__init__.py,sha256=gEfqa4nhhKYjbk9g07WpJuzU5iAeEHFRGUSvA4VXm8k,108
-papers/__main__.py,sha256=Ua07_Qb57lce0jOYp3jrKH7kPGM8QvVUiwtIkFOFxAc,57292
-papers/_version.py,sha256=FBqtgBb5hG2kHWDiVQT5o8_jJfQmv2FROzH4xAlajxU,411
-papers/bib.py,sha256=SFXwNnF0KR71TbtHymPqQ9rrugjjSCeQfAH_HH0MYF4,29761
-papers/config.py,sha256=ufLMp0rBP62bEtesh1s7DZ3FsY4v9Ys669JBua4K_HU,9761
-papers/duplicate.py,sha256=AgGh3QHgE1ZqqqAm8_j13Ao3T-1K-Qe6O8tC4Cyw4DQ,18723
-papers/encoding.py,sha256=S-36AltnOCTCrJ-eSQWQYR4T095KRnPwJQB_15M7Ai0,3929
-papers/extract.py,sha256=-RJ8N_AMimjL3jp91txpL7E2vUhEAO-QlT-XssxjqAM,11757
-papers/filename.py,sha256=1uuVnbNkpRogALvDnsy2THfxAuQ2kTH2vlgpfEzsKoI,4744
-papers/latexenc.py,sha256=qH03t6yVUnGZvkZT2-9OWXU-iHqZvVthhQopaM281D4,98127
-papers/utils.py,sha256=Hql6Rlnd4SKb8CcumTx0Vw41kUUeJuGfo8UTrOt98PQ,5164
-papers_cli-2.7.2.dist-info/LICENSE,sha256=Uc7FclCyMqKU9cc366vVpOLy9gU2w5btUJX9EDzQVIw,1071
-papers_cli-2.7.2.dist-info/METADATA,sha256=vQv1NB70X2zg35kellxT9JM1-ZOCNySDEkNXMoUiVds,18325
-papers_cli-2.7.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-papers_cli-2.7.2.dist-info/entry_points.txt,sha256=E1H8yJ7ieFOJT8rLGPQOQB7I1KbqTrcjze3FPfgk8uI,59
-papers_cli-2.7.2.dist-info/top_level.txt,sha256=sLdcLzjapCbtCY-yXhtEHZEniJB7I35rxRLLLURc8mo,7
-papers_cli-2.7.2.dist-info/RECORD,,