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](screenshot.png)

## 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

  • 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 via regular expression.

  • n: Edit notes.

  • t: Edit tags.

  • 0..5: Set voting.

  • y: Show all stored information about a paper.

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.15.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

papr-0.0.15-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: papr-0.0.15.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for papr-0.0.15.tar.gz
Algorithm Hash digest
SHA256 40dea0bc424e5d5ae29a5e7b8ec7a4039707e5f82798d356d7da2a66589bccdf
MD5 7c6bd4063df3f0a24000bb1c932208cf
BLAKE2b-256 120033e0e6523161520b3d85804932077adc0cf4eef901b05aa13c2f944851cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: papr-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for papr-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 8ec906a5f3c6a336611d48f80e67df6799ca3bb39a40c3367e0b9330ad7182c0
MD5 d53aee041b0919eaae33e3d38fe010e6
BLAKE2b-256 694e0343662841b021ee969e512d7e3afe686a199be8cd2d4a95cfef106b53e5

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