Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/papis/papis

Powerful and highly extensible command-line based document and bibliography manager.
https://github.com/papis/papis

arxiv biblatex bibtex citation cli command-line command-line-tool crossref doi jabref libgen library mendeley papers papis publications scholar sci-hub tex zotero

Last synced: about 1 month ago
JSON representation

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

Lists

README 

        
Papis

=====



|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 `__):



.. code:: bash



    pip install papis



Let's download a couple of documents:



.. code:: bash



    wget http://www.gnu.org/s/libc/manual/pdf/libc.pdf

    wget http://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``.



.. code:: bash



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



|add|



You can also use ``--set`` to add information:



.. code:: bash



    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:



.. code:: bash



    papis open

    papis edit



|edit|



Or export them to bibtex:



.. code:: bash



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



|bibtex_export|



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



.. code:: bash



    papis serve



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



|web_app|



All Papis commands come with help messages:



.. code:: bash



    papis -h      # General help

    papis add -h  # Help with a specific Papis command



Installation & setup

--------------------



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



- `Installation `__

- `Configuration `__

- `Import `__

- `Editor integration `__



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!



Reviews and blog posts

----------------------



- `Blog post `__ about getting a paper's references with ``papis explore``.

- `Blog post `__ about using Papis with Zotero and Syncthing.

- GNU/Linux Switzerland `wrote about Papis `__ *(in German)*.

- The folks at OSTechNix wrote a review of `Papis

  `__.

- A `review of Papis `__ by Ubunlog *(in Spanish)*.



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.



.. list-table::

   :widths: 33 67

   :header-rows: 1



   * - 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 `__

     - `lennonhill `__



   * - `papis-libgen `__

     - you?



   * - `papis-firefox `__

     - `wavefrontshaping `__



Related software

----------------



Papis isn't the only fish in the pond. You might also be interested in:



- `bibman `__ (opensource)

- `cobib `__ (opensource)

- `jabref `__ (opensource)

- `Mendeley `__ (proprietary)

- `pubs `__ (opensource)

- `Xapers `__ (opensource)

- `Zotero `__ (opensource)



.. |ghbadge| image:: https://github.com/papis/papis/workflows/CI/badge.svg

   :target: https://github.com/papis/papis/actions?query=branch%3Amain+workflow%3ACI

.. |RTD| image:: https://readthedocs.org/projects/papis/badge/?version=latest

   :target: http://papis.readthedocs.io/en/latest/?badge=latest

.. |CodeQL| image:: https://github.com/papis/papis/workflows/CodeQL/badge.svg

   :target: https://github.com/papis/papis/actions?query=branch%3Amain+workflow%3ACodeQL



.. |Pypi| image:: https://badge.fury.io/py/papis.svg

   :target: https://pypi.org/project/papis/

.. |zenodo_badge| image:: https://zenodo.org/badge/82691622.svg

   :target: https://zenodo.org/badge/latestdoi/82691622



.. |first_glance| image:: https://papis.github.io/images/first_glance.gif

.. |edit| image:: https://papis.github.io/images/edit.gif

.. |bibtex_export| image:: https://papis.github.io/images/bibtex_export.gif

.. |add| image:: https://papis.github.io/images/add.gif

.. |web_app| image:: https://papis.github.io/images/web_app.jpg