Repository files navigation

To install the latest release from PyPI

python -m pip install papis-zotero

To install the latest development version

python -m pip install papis-zotero@https://github.com/papis/papis-zotero.git#egg=papis-zotero

For Nix and NixOS users, a Nix flake is included in this repository and can beused to install the package. There are many ways of doing so, for instance like so:

{pkgs,inputs,  ...}:{home.packages=withpkgs;[(python3.withPackages(ps:[inputs.papis.packages.${system}.defaultinputs.papis-zotero.packages.${system}.default# you can add other packages you might want to make available for papis# ps.jinja2]))# Here you can list other packages, such as# typst# hayagriva# zotero_7];}

Arch users can use the AUR to installthe package.

Zotero also maintains a database of all its files and collections under azotero.sqlite file. You can check where this file is located by going toEdit > Preferences > Advanced > Data Directory Location (may vary dependingon the Zotero version). The Zotero data directory should contain thezotero.sqlitefile and astorage directory with the files for each document.

The SQLite database maintained by Zotero can be imported directly (withoutusing a BibTeX export) bypapis-zotero. This can be done with:

papis zotero import --from-sql-folder<ZOTERO_DATA_DIRECTORY>

Here,ZOTERO_DATA_DIRECTORY is the folder containing thezotero.sqlitefile. By default,papis-zotero will add the imported documents to yourcurrent library directory, but it can be customized using the--outfolder argument.

Zotero can export different variants of BibTeX or BibLaTeX files(fromFiles > Export Library). You could import the resulting.bib filedirectly with Papis (with thepapis bibtex command), butpapis-zoteroprovides a specialised command. This command has better support for special Zoterofields. To import a given exported library run:

papis zotero import --from-bibtex library.bib

BibTeX files exported by Zotero can include attached files as shown in the belowexample:

@article{Einstein1905Photon,author ={ A. Einstein},doi ={ 10.1002/andp.19053220607},journal ={ Ann. Phys.},pages ={ 132--148},title ={ Über einen die Erzeugung und Verwandlung des Lichtes        betreffenden heuristischen Gesichtspunkt},file ={ Full Text:path/to/some/relative/file.pdf},volume ={ 322},year ={ 1905},}

Given this,papis-zotero will interpret the path of thefile entryas a relative path to thelibrary.bib passed to the import command using--from-bibtex. The files are skipped if they do not exist at the expectedlocation.

By default,papis-zotero will add the documents to your current library.When initially importing a big library, it is recommended to always import itinto a scratch folder, so that you can verify the import. This can be easily doneusing:

papis zotero import --from-bibtex library.bib --outfolder some/folder/lib

When you are ready you can move this folder to a final Papis library.

This plugin can also connect to a Zotero connector browser plugin. First, sucha plugin should be installed from theZotero website. Then, make sure thatZotero itself is not running (and connected to the connector) and run:

papis zotero serve

Papis now starts listening to your browser for incoming data. Whenever you click theZotero button to add a paper,papis-zotero will add this paper to the Papislibrary instead.

This project usespyproject.toml andhatchling for its build system.To develop the code, it is recommended to start up avirtual environment andinstall the project in editable mode using, e.g.:

python -m pip install -e '.[develop]'

After installation, always check that the command is correctly recognized, e.g.by looking at the help output

papis zotero --help

If you use the Nix flake, you can also use the includeddevShell withnix develop.