A command line tool to manage scientific papers.
Project description
Papr
Papr is a tool to manage and quickly access scientific papers on the command line.
Features
- Fast search: search in the title of papers via regular expressions or trigrams.
- Notes: create notes for each paper.
- Rating of papers: rate your papers via a five star rating system.
- Tags: assign each paper different tags.
- Import from arXiv: automatically import papers with title and abstract from arXiv
Install
You can install papr via pip:
pip install papr
Getting started.
Papers are organized in repositories. To create a repository change into a directory where the repository should be created and type papr init
. Example:
cd astro_repo
papr init
This will create a directory .paper
in the astro_repo
directory to store metadata. All PDFs will be stored in astro_repo
.
Default repositories
The last repository which you create with papr init
is set as the default repository. If you call papr
without being in a repository the default repository will be used for all operations. Otherwise, the current working directory will be used as the repository.
Fetch a paper from arXiv.org or OpenReview.net
Fetching a document from arXiv is quite easy. You just have to provide the URL of the abstract and papr will download the PDF and will automatically extract the title and abstract. Example:
papr fetch https://arxiv.org/abs/1812.07561
The same does also work for papers on OpenReview.net:
papr fetch https://openreview.net/forum?id=HkNDsiC9KQ
Run
When you have added papers to your repository you can run papr by simply executing:
papr
You will see your list of papers through which you can navigate.
Further information
Run papr --help
for further information.
Key shortcuts
- h: Help / List of key bindings.
- q / ESC: Quit.
- ENTER: Open the paper in a PDF reader.
- a: Show abstract for paper.
- i / Arrow up: Move selection up.
- k / Arrow down: Move selection down.
- s: Live search in title.
- r: Live search in title via regular expression.
- n: Edit notes.
- t: Edit tags.
- 0..5: Set voting.
- y: Show all stored information about a paper.
- l: Show statistics about tags.
- f: Filter (e.g. by tags).
- F: Clear filter.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file papr-0.0.20.tar.gz
.
File metadata
- Download URL: papr-0.0.20.tar.gz
- Upload date:
- Size: 25.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef2598e75fc6598efb6e77a953ad2dc6090977acccac0ca2c5b48f1a39dd3c14 |
|
MD5 | a1d37ca8bac7bb0bdaeafe3c618e0ee6 |
|
BLAKE2b-256 | f89f83536a84b2d2cac7571281f2f075fd0f262779ffe15c2223267816cf4e91 |
File details
Details for the file papr-0.0.20-py3-none-any.whl
.
File metadata
- Download URL: papr-0.0.20-py3-none-any.whl
- Upload date:
- Size: 35.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 311df87618e8c571693954bcef995d75994d5b617e1431cf2cdf8eb06c953850 |
|
MD5 | e8f3ee5ce37f55803f6e14f557ab184c |
|
BLAKE2b-256 | d0b8528c3f46ededb25e290d1c2bb6aeba3b97faadeb348d0352f14565fe9231 |