Skip to main content

Powerful and highly extensible command-line based document and bibliography manager

Project description

ghbadge RTD CodeQL Pypi zenodo_badge

Papis is a powerful and highly extensible CLI document and bibliography manager.

first_glance

With Papis, you can search your library for books and papers, add documents and notes, import and export to and from other formats, and much much more. Papis uses a human-readable and easily hackable .yaml file to store each entry’s bibliographical data. It strives to be easy to use while providing a wide range of features. And for those who still want more, Papis makes it easy to write scripts that extend its features even further.

Features

  • Add documents and automatically fetch their metadata.

  • Search by author, title, tags, and so on.

  • Synchronize your library with whatever software you’re already using.

  • Share your documents with colleagues without having to force some proprietary service onto them.

  • Import your data from other bibliography managers.

  • Export to BibTeX and other formats.

  • Integrate with your editor with plugins for (Neo)vim and Emacs.

  • TUIs make it easy to get a quick overview of your library.

  • Use the web app when the CLI doesn’t quite cut it (for example on your tablet).

  • Hacking Papis is easy! Use the API to easily create your own custom python scripts.

Quick tour

Install Papis with pip (or one of the alternatives):

pip install papis

Let’s download a couple of documents:

wget https://www.gnu.org/s/libc/manual/pdf/libc.pdf
wget https://www.ams.org/notices/201304/rnoti-p434.pdf

We can now add these to the (default) library. This will automatically query for the metadata associated with the doi.

papis add --from doi 10.1090/noti963 rnoti-p434.pdf

add

You can also use --set to add information:

papis add libc.pdf --set author "Sandra Loosemore" \
                   --set title "GNU C reference manual" \
                   --set year 2018 \
                   --set tags programming \
                   --confirm

Now open an attached file or edit an entry:

papis open
papis edit

edit

The Papis picker (set using the picktool configuration option) has helpful shortcuts to call other functionality as well (press F1 for a complete list). It can be used to open (Ctrl-o), browse (Ctrl-b) or edit (Ctrl-e) selected documents (marked with Ctrl-t).

Import your bibliography into Papis from BibTeX:

papis bibtex read mylib.bib import --all

Or export it to BibTeX:

papis export --all --format bibtex > mylib.bib

bibtex_export

Papis also includes a web app that you can start with:

papis serve

You can then open the indicated address (http://localhost:8888) in your browser.

web_app

All papis commands come with help messages:

papis -h      # General help
papis add -h  # Help with a specific command

Installation & setup

Information about installation and setup can be found in the docs, for example in the these sections:

Questions?

The docs cover Papis’ features and discuss possible work flows. If you still have questions, head to our GitHub discussions — we’re more than happy to help. If you’ve found a bug, please open an issue and help make Papis even better!

If you’re not finding a command or configuration value that shows up in the documentation in your local installation, you may just be looking at the wrong docs. You can find the documentation for the latest released version here and the documentation for the in-development version here.

Reviews and blog posts

Contributing

Contributions are very welcome! Take a look at CONTRIBUTING.md for general rules and HACKING.md for additional code-related information. We encourage you to also check out, contribute to, or even help maintain the other projects in the Papis ecosystem mentioned below :wink:.

The Papis ecosystem

Papis has grown over the years and there are now a number of projects that extend Papis’ features or integrate it with other software.

Project

Maintained by

papis (core)

Alejandro Gallo, Julian Hauser, Alex Fikl

papis-rofi

Etn40ff

papis-dmenu

you?

papis-vim

you?

papis.nvim

Julian Hauser

papis-emacs

Alejandro Gallo

papis-zotero

Alex Fikl

papis-libgen

you?

papis-firefox

wavefrontshaping

papis-qa (AI for Papis)

Isak Samsten

Thanks

We thank Irteza Rehman for generously creating our beautiful logo.

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

papis-0.14.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

papis-0.14.1-py3-none-any.whl (256.4 kB view details)

Uploaded Python 3

File details

Details for the file papis-0.14.1.tar.gz.

File metadata

  • Download URL: papis-0.14.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for papis-0.14.1.tar.gz
Algorithm Hash digest
SHA256 1970e549d8931d560b283bdc883a744f1634afbf23bad8eb244dfa967f66ba78
MD5 c64a2aa8de0add53d6f8821469498caa
BLAKE2b-256 7ad32b346625aa3803e47b9faa82b1a66a824e91c43cf45e5b228009060fb666

See more details on using hashes here.

Provenance

The following attestation bundles were made for papis-0.14.1.tar.gz:

Publisher: main.yml on papis/papis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file papis-0.14.1-py3-none-any.whl.

File metadata

  • Download URL: papis-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 256.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for papis-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a729d8c84c619fe172bc636fa9e3a285919cafc14caedb53cf69b0a26ed7d64a
MD5 4aa526c869563f2e8142d76431e2caff
BLAKE2b-256 e4a5a3a3ca0debe192f4d6b057858ac267e1737a369e2b9887c04fc7c4a47bb9

See more details on using hashes here.

Provenance

The following attestation bundles were made for papis-0.14.1-py3-none-any.whl:

Publisher: main.yml on papis/papis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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