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

![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

  • 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.18.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

papr-0.0.18-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: papr-0.0.18.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.9

File hashes

Hashes for papr-0.0.18.tar.gz
Algorithm Hash digest
SHA256 b13511633137fc100d6f0429da583737295bf0f75e3265f9b5d76ce9d5fb1044
MD5 48b4dfccdb569a86ffd1d6d4dcc903a6
BLAKE2b-256 edfcd2c3c6c8e2a0d145ede8f08b5ae1574ee6cdb040480b125199b119e3036c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: papr-0.0.18-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.9

File hashes

Hashes for papr-0.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 f13036a209dff65aa8542da9dad5a96dd5c76a6ebb12941fa972227b3c151711
MD5 312a112611e21e5540f2cc3d191a678f
BLAKE2b-256 4d90f3cd628df34dfe0604ea8f944875a317b8bb0b97dae22493677e56d0ba1c

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