papers-cli 2.4__tar.gz → 2.5__tar.gz

{papers-cli-2.4 → papers_cli-2.5}/.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.8", "3.9", "3.10" ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13"  ]
 
     steps:
     - uses: actions/checkout@v2

papers_cli-2.5/.gitignore

@@ -0,0 +1,15 @@
+*.egg-info/
+*.pyc
+.tox
+.cache
+__pycache__
+build
+MANIFEST
+papers/_version.py
+dist/
+.coverage
+htmlcov/
+.venv
+.pytest_cache
+papers.sublime-project
+papers.sublime-workspace

{papers-cli-2.4 → papers_cli-2.5}/PKG-INFO

@@ -1,21 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.4
+Version: 2.5
 Summary: utilities to keep your PDF library organized
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT
 Project-URL: homepage, https://github.com/perrette/papers
 Keywords: bibtex,references,bibliography
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: unidecode
+Requires-Dist: crossrefapi
+Requires-Dist: bibtexparser
+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)
-[![python](https://img.shields.io/badge/python-3.8-blue.svg)]()
 [![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)]()
+[![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
+[![python](https://img.shields.io/badge/python-3.13-blue.svg)]()
 
 # papers
 
@@ -27,7 +34,7 @@ That said, it is becoming useful :)
 ## Motivation
 
 This project is an attempt to create a light-weight,
-command-line bibliography managenent tool. Aims:
+command-line bibliography management tool. Aims:
 
 - maintain a PDF library (with appropriate naming)
 - maintain one or several bibtex-compatible collections, linked to PDFs
@@ -36,7 +43,7 @@ command-line bibliography managenent tool. Aims:
 
 ## Dependencies
 
-- python 3.8+
+- python 3.9+
 - [poppler-utils](https://en.wikipedia.org/wiki/Poppler_(software)) (only:`pdftotext`): convert PDF to text for parsing
 - [bibtexparser](https://bibtexparser.readthedocs.io) : parse bibtex files
 - [crossrefapi](https://github.com/fabiobatalha/crossrefapi) : make polite requests to crossref API
@@ -103,7 +110,15 @@ If you already know the DOI of a PDF, and don't want to gamble the fulltext sear
 The `add` command above also works without any PDF (create a bibtex entry without file attachment).
 
     papers add --doi 10.5194/esd-4-11-2013 --bibtex papers.bib
-    
+
+
+### Add entry without DOI from bibtex library + PDF
+
+Some old files don't have a DOI. Best is to add the entry from its bibtex:
+
+    papers add entry.bib --attachment esd-4-11-2013.pdf
+
+
 ### List entries (and edit etc...)
 
 Pretty listing (-1 or -l for one-liner listing, otherwise plain bibtex):
@@ -206,7 +221,7 @@ Sometimes it is desirable to have separate configurations. In that case a local
     Bibtex file name [default to existing: papers.bib] [Enter/Yes/No]:
     Files folder [default to new: papers] [Enter/Yes/No]: pdfs
     papers configuration
-    * configuration file: .papers/config.json
+    * configuration file: papersconfig.json
     * cache directory:    /home/perrette/.cache/papers
     * absolute paths:     True
     * git-tracked:        False
@@ -234,7 +249,7 @@ and remove the configuration file by hand (`rm ...`). Or use `papers uninstall`
 
     papers uninstall
 
-You may repeat `papers status -v` and cleaning until a satistfying state is reached, or remove all config files recursively up to (and including) global install:
+You may repeat `papers status -v` and cleaning until a satisfying state is reached, or remove all config files recursively up to (and including) global install:
 
     papers uninstall --recursive
 
@@ -242,7 +257,7 @@ You may repeat `papers status -v` and cleaning until a satistfying state is reac
 ### Relative versus Absolute path
 
 By default, the file paths in the bibtex are stored as absolute paths (starting with `/`), except for local installs.
-It is possible to change this behavious explicitly during install or in a case by case basis with `--relative-paths` or `--absolute-paths` options.
+It is possible to change this behaviour explicitly during install or in a case by case basis with `--relative-paths` or `--absolute-paths` options.
 With or without install.
 
 
@@ -255,7 +270,7 @@ Simple cases are:
 In any other cases, you risk breaking the file links.
 
 Papers tries to be as little opinionated as possible about how files are organized, and so it relies on your own judgement and use case.
-When loading a bibtex, it always inteprete relative file links as being relative to the bibtex file.
+When loading a bibtex, it always interprete relative file links as being relative to the bibtex file.
 When saving a bibtex, it will save file links accordingly to the default setting path (usually absolute, unless local install or unless you specify otherwise).
 
 In any case, the following set of commands will always work provided the initial file links are valid (optional parameters in brackets):

{papers-cli-2.4 → papers_cli-2.5}/README.md

@@ -1,8 +1,9 @@
 [![test](https://github.com/perrette/papers/workflows/CI/badge.svg)](https://github.com/perrette/papers/actions)
-[![python](https://img.shields.io/badge/python-3.8-blue.svg)]()
 [![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)]()
+[![python](https://img.shields.io/badge/python-3.12-blue.svg)]()
+[![python](https://img.shields.io/badge/python-3.13-blue.svg)]()
 
 # papers
 
@@ -14,7 +15,7 @@ That said, it is becoming useful :)
 ## Motivation
 
 This project is an attempt to create a light-weight,
-command-line bibliography managenent tool. Aims:
+command-line bibliography management tool. Aims:
 
 - maintain a PDF library (with appropriate naming)
 - maintain one or several bibtex-compatible collections, linked to PDFs
@@ -23,7 +24,7 @@ command-line bibliography managenent tool. Aims:
 
 ## Dependencies
 
-- python 3.8+
+- python 3.9+
 - [poppler-utils](https://en.wikipedia.org/wiki/Poppler_(software)) (only:`pdftotext`): convert PDF to text for parsing
 - [bibtexparser](https://bibtexparser.readthedocs.io) : parse bibtex files
 - [crossrefapi](https://github.com/fabiobatalha/crossrefapi) : make polite requests to crossref API
@@ -90,7 +91,15 @@ If you already know the DOI of a PDF, and don't want to gamble the fulltext sear
 The `add` command above also works without any PDF (create a bibtex entry without file attachment).
 
     papers add --doi 10.5194/esd-4-11-2013 --bibtex papers.bib
-    
+
+
+### Add entry without DOI from bibtex library + PDF
+
+Some old files don't have a DOI. Best is to add the entry from its bibtex:
+
+    papers add entry.bib --attachment esd-4-11-2013.pdf
+
+
 ### List entries (and edit etc...)
 
 Pretty listing (-1 or -l for one-liner listing, otherwise plain bibtex):
@@ -193,7 +202,7 @@ Sometimes it is desirable to have separate configurations. In that case a local
     Bibtex file name [default to existing: papers.bib] [Enter/Yes/No]:
     Files folder [default to new: papers] [Enter/Yes/No]: pdfs
     papers configuration
-    * configuration file: .papers/config.json
+    * configuration file: papersconfig.json
     * cache directory:    /home/perrette/.cache/papers
     * absolute paths:     True
     * git-tracked:        False
@@ -221,7 +230,7 @@ and remove the configuration file by hand (`rm ...`). Or use `papers uninstall`
 
     papers uninstall
 
-You may repeat `papers status -v` and cleaning until a satistfying state is reached, or remove all config files recursively up to (and including) global install:
+You may repeat `papers status -v` and cleaning until a satisfying state is reached, or remove all config files recursively up to (and including) global install:
 
     papers uninstall --recursive
 
@@ -229,7 +238,7 @@ You may repeat `papers status -v` and cleaning until a satistfying state is reac
 ### Relative versus Absolute path
 
 By default, the file paths in the bibtex are stored as absolute paths (starting with `/`), except for local installs.
-It is possible to change this behavious explicitly during install or in a case by case basis with `--relative-paths` or `--absolute-paths` options.
+It is possible to change this behaviour explicitly during install or in a case by case basis with `--relative-paths` or `--absolute-paths` options.
 With or without install.
 
 
@@ -242,7 +251,7 @@ Simple cases are:
 In any other cases, you risk breaking the file links.
 
 Papers tries to be as little opinionated as possible about how files are organized, and so it relies on your own judgement and use case.
-When loading a bibtex, it always inteprete relative file links as being relative to the bibtex file.
+When loading a bibtex, it always interprete relative file links as being relative to the bibtex file.
 When saving a bibtex, it will save file links accordingly to the default setting path (usually absolute, unless local install or unless you specify otherwise).
 
 In any case, the following set of commands will always work provided the initial file links are valid (optional parameters in brackets):