papers-cli 2.7.2__tar.gz → 2.8__tar.gz

{papers_cli-2.7.2 → papers_cli-2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.7.2
+Version: 2.8
 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.7.2 → papers_cli-2.8}/README.md

@@ -1,4 +1,4 @@
-[![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)]()
@@ -102,25 +102,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.7.2 → papers_cli-2.8}/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
 from papers import __version__
 
 
@@ -801,15 +801,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 +852,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 +1124,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_cli-2.7.2 → papers_cli-2.8}/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.8'
+__version_tuple__ = version_tuple = (2, 8)

{papers_cli-2.7.2 → papers_cli-2.8}/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_cli-2.7.2 → papers_cli-2.8}/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()}"
+        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_cli-2.7.2 → papers_cli-2.8}/papers_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.7.2
+Version: 2.8
 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.7.2 → papers_cli-2.8}/tests/test_list.py

@@ -40,99 +40,99 @@ class FormattingTest(ListTest):
 class SearchTest(ListTest):
 
     def test_list_title(self):
-        out = self.papers(f'list --title "ice-edge blooms"', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title "ice-edge blooms"', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_title_fuzzy(self):
-        out = self.papers(f'list --title "ice edge bloom arctc"', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title "ice edge bloom arctc"', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --title "ice edge bloom arctc" --fuzzy', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title "ice edge bloom arctc" --fuzzy', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_title_multiple(self):
-        out = self.papers(f'list --title ice edge', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title ice edge', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --title ice edge antarctic', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title ice edge antarctic', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --title ice edge antarctic --any', sp_cmd='check_output')
+        out = self.papers(f'list --plain --title ice edge antarctic --any', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_author(self):
-        out = self.papers(f'list --author perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain --author perrette', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --author perrette balafon', sp_cmd='check_output')
+        out = self.papers(f'list --plain --author perrette balafon', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --author perrette balafon --any', sp_cmd='check_output')
+        out = self.papers(f'list --plain --author perrette balafon --any', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_key(self):
-        out = self.papers(f'list --key perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain --key perrette', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --key perrette --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain --key perrette --strict', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --key perrette_2011 --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain --key perrette_2011 --strict', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_year(self):
-        out = self.papers(f'list --year 201', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 201', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --year 201 --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 201 --strict', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --year 2011 --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 2011 --strict', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
     def test_list_tag(self):
-        out = self.papers(f'list --tag kiwi', sp_cmd='check_output')
+        out = self.papers(f'list --plain --tag kiwi', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --tag kiwi ocean', sp_cmd='check_output')
+        out = self.papers(f'list --plain --tag kiwi ocean', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list --tag kiwi bonobo', sp_cmd='check_output')
+        out = self.papers(f'list --plain --tag kiwi bonobo', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --tag kiwi bonobo --any', sp_cmd='check_output')
+        out = self.papers(f'list --plain --tag kiwi bonobo --any', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
 
     def test_list_combined(self):
-        out = self.papers(f'list --year 2011 --author perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 2011 --author perrette', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
         # Here we'd need the full name (never useful in practice)
-        out = self.papers(f'list --year 2011 --author perrette --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 2011 --author perrette --strict', sp_cmd='check_output')
         self.assertEqual(out, "")
 
-        out = self.papers(f'list --year 2021 --author perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 2021 --author perrette', sp_cmd='check_output')
         self.assertEqual(out, "")
 
         # --any has no effect on multiple strings
-        out = self.papers(f'list --year 2021 --author perrette --any', sp_cmd='check_output')
+        out = self.papers(f'list --plain --year 2021 --author perrette --any', sp_cmd='check_output')
         self.assertEqual(out, "")
 
 
     def test_list_fullsearch(self):
-        out = self.papers(f'list 2011 perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain 2011 perrette', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
         # --strict is deactivated
-        out = self.papers(f'list 2011 perrette --strict', sp_cmd='check_output')
+        out = self.papers(f'list --plain 2011 perrette --strict', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)
 
-        out = self.papers(f'list 2021 perrette', sp_cmd='check_output')
+        out = self.papers(f'list --plain 2021 perrette', sp_cmd='check_output')
         self.assertEqual(out, "")
 
         # any works well on full search strings
-        out = self.papers(f'list 2021 perrette --any', sp_cmd='check_output')
+        out = self.papers(f'list --plain 2021 perrette --any', sp_cmd='check_output')
         self.assertMultiLineEqual(out, self.initial_content)