Skip to main content

A command line tool to manage scientific papers.

Project description

Papr

Papr is a tool to manage and quickly access scientific papers from the command line.

Features

  • Fast search: search in the title of papers via regular expressions.
  • Notes: create notes for each paper.
  • Rating of papers: rate your papers via five star rating system.
  • Tags: assign each paper different tags.

papr

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

papr-0.0.17.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

papr-0.0.17-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file papr-0.0.17.tar.gz.

File metadata

  • Download URL: papr-0.0.17.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.3

File hashes

Hashes for papr-0.0.17.tar.gz
Algorithm Hash digest
SHA256 08abe11c3a783de98cda4448562303db673fd021188abc66a47cd76b1fcaccd3
MD5 bc7cce1fc335292d8b6467f967a4d59f
BLAKE2b-256 59fa496900b5e2be12de6b23637d8b45a0fd92bd8611049d8f3f21235d06d933

See more details on using hashes here.

File details

Details for the file papr-0.0.17-py3-none-any.whl.

File metadata

  • Download URL: papr-0.0.17-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.3

File hashes

Hashes for papr-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 2ab2932e398f5b671821df069e72c2ffadd88e0185407c82261379a51cf1f6a5
MD5 0130023274dc675a89d6026fd1914e65
BLAKE2b-256 2b3f477b8f9456ed7b666c1da24b941ca7baf1d4958835fd394aec9e7b61068d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page