.. image:: https://badge.fury.io/py/papis-zotero.svg
:target: https://badge.fury.io/py/papis-zotero
.. image:: https://github.com/papis/papis-zotero/workflows/CI/badge.svg
:target: https://github.com/papis/papis-zotero/actions?query=branch%3Amaster+workflow%3ACI
Zotero compatibility for papis
==============================
Installation
------------
To install the latest release from PyPI
.. code:: bash
python -m pip install papis-zotero
To install the latest development version
.. code:: bash
python -m pip install papis-zotero@https://github.com/papis/papis-zotero.git#egg=papis-zotero
Development
-----------
This project uses ``setup.py`` and ``setuptools`` for its build system.
To develop the code, it is recommended to start up a
`virtual environment <https://docs.python.org/3/library/venv.html>`__ and
install 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
.. code:: bash
papis zotero --help
Importing from BibTeX
---------------------
Zotero supports exporting different variants of BibTeX or BibLaTeX files
(from ``Files > Export Library``). The resulting ``bib`` file can be directly
imported into ``papis`` using
.. code:: bash
papis bibtex read library.bib import --all
but a better choice is using this command, as it has better support for special
Zotero fields. To import a given exported library run
.. code:: bash
papis zotero import --from-bibtex library.bib
BibTeX files exported by Zotero can also include has some PDF entries, e.g.
they can look like
.. code:: bibtex
@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 },
}
From this, ``papis-zotero`` will interpret the path of the ``file`` entry
as a relative path to ``library.bib`` passed to the import command using
``--from-bibtex``. The files are skipped if they do not exist at the expected
location.
By default, ``papis-zotero`` will add the documents to your current library.
When initially importing a big library, it is recommended to always import it
into a scratch folder, so that you can check the import. This can be easily done
using
.. code:: bash
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.
Importing from Zotero SQLite
----------------------------
Zotero also maintains a database of all its files and collections under a
``zotero.sqlite`` file. You can check where this file is located by going to
``Edit > Preferences > Advanced > Data Directory Location`` (may vary depending
on the Zotero version). The Zotero data directory should contain the ``zotero.sqlite``
file and a ``storage`` directory with the files for each document.
The SQLite database maintained by Zotero can be imported directly (without
using a BibTeX export) by ``papis-zotero``. This can be done by passing
.. code:: bash
papis zotero import --from-sql-folder <ZOTERO_DATA_DIRECTORY>
where ``ZOTERO_DATA_DIRECTORY`` is the folder containing the ``zotero.sqlite``
file. By default, ``papis-zotero`` will add the imported documents to your
current library directory, but it can be customized using the
``--outfolder`` argument.
Using Zotero connectors
-----------------------
This plugin can also connect to a Zotero connector browser plugin. First, one
such plugin should be installed from the
`Zotero website <https://www.zotero.org/download/>`__. Then, make sure that
Zotero itself is not running (and connected to the connector) and run
.. code:: bash
papis zotero serve
to start listening to your browser for incoming data. Whenever you click the
Zotero button to add a paper, ``papis-zotero`` will add this paper to its
library instead.
Raw data
{
"_id": null,
"home_page": "https://github.com/papis/papis-zotero",
"name": "papis-zotero",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bibtex,biliography,cli,management,papis,zotero",
"author": "Alejandro Gallo",
"author_email": "aamsgallo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/be/287d2fd72c54ad9d764fcb60d2a2812af820dbeeb3586842eee27241c821/papis-zotero-0.1.2.tar.gz",
"platform": "linux",
"description": ".. image:: https://badge.fury.io/py/papis-zotero.svg\n :target: https://badge.fury.io/py/papis-zotero\n.. image:: https://github.com/papis/papis-zotero/workflows/CI/badge.svg\n :target: https://github.com/papis/papis-zotero/actions?query=branch%3Amaster+workflow%3ACI\n\nZotero compatibility for papis\n==============================\n\nInstallation\n------------\n\nTo install the latest release from PyPI\n\n.. code:: bash\n\n python -m pip install papis-zotero\n\nTo install the latest development version\n\n.. code:: bash\n\n python -m pip install papis-zotero@https://github.com/papis/papis-zotero.git#egg=papis-zotero\n\nDevelopment\n-----------\n\nThis project uses ``setup.py`` and ``setuptools`` for its build system.\nTo develop the code, it is recommended to start up a\n`virtual environment <https://docs.python.org/3/library/venv.html>`__ and\ninstall the project in editable mode using, e.g.::\n\n python -m pip install -e '.[develop]'\n\nAfter installation always check that the command is correctly recognized, e.g.\nby looking at the help output\n\n.. code:: bash\n\n papis zotero --help\n\nImporting from BibTeX\n---------------------\n\nZotero supports exporting different variants of BibTeX or BibLaTeX files\n(from ``Files > Export Library``). The resulting ``bib`` file can be directly\nimported into ``papis`` using\n\n.. code:: bash\n\n papis bibtex read library.bib import --all\n\nbut a better choice is using this command, as it has better support for special\nZotero fields. To import a given exported library run\n\n.. code:: bash\n\n papis zotero import --from-bibtex library.bib\n\nBibTeX files exported by Zotero can also include has some PDF entries, e.g.\nthey can look like\n\n.. code:: bibtex\n\n @article{Einstein1905Photon,\n author = { A. Einstein },\n doi = { 10.1002/andp.19053220607 },\n journal = { Ann. Phys. },\n pages = { 132--148 },\n title = { \u00dcber einen die Erzeugung und Verwandlung des Lichtes\n betreffenden heuristischen Gesichtspunkt },\n file = { Full Text:path/to/some/relative/file.pdf },\n volume = { 322 },\n year = { 1905 },\n }\n\nFrom this, ``papis-zotero`` will interpret the path of the ``file`` entry\nas a relative path to ``library.bib`` passed to the import command using\n``--from-bibtex``. The files are skipped if they do not exist at the expected\nlocation.\n\nBy default, ``papis-zotero`` will add the documents to your current library.\nWhen initially importing a big library, it is recommended to always import it\ninto a scratch folder, so that you can check the import. This can be easily done\nusing\n\n.. code:: bash\n\n papis zotero import --from-bibtex library.bib --outfolder some/folder/lib\n\nWhen you are ready you can move this folder to a final ``papis`` library.\n\nImporting from Zotero SQLite\n----------------------------\n\nZotero also maintains a database of all its files and collections under a\n``zotero.sqlite`` file. You can check where this file is located by going to\n``Edit > Preferences > Advanced > Data Directory Location`` (may vary depending\non the Zotero version). The Zotero data directory should contain the ``zotero.sqlite``\nfile and a ``storage`` directory with the files for each document.\n\nThe SQLite database maintained by Zotero can be imported directly (without\nusing a BibTeX export) by ``papis-zotero``. This can be done by passing\n\n.. code:: bash\n\n papis zotero import --from-sql-folder <ZOTERO_DATA_DIRECTORY>\n\nwhere ``ZOTERO_DATA_DIRECTORY`` is the folder containing the ``zotero.sqlite``\nfile. By default, ``papis-zotero`` will add the imported documents to your\ncurrent library directory, but it can be customized using the\n``--outfolder`` argument.\n\nUsing Zotero connectors\n-----------------------\n\nThis plugin can also connect to a Zotero connector browser plugin. First, one\nsuch plugin should be installed from the\n`Zotero website <https://www.zotero.org/download/>`__. Then, make sure that\nZotero itself is not running (and connected to the connector) and run\n\n.. code:: bash\n\n papis zotero serve\n\nto start listening to your browser for incoming data. Whenever you click the\nZotero button to add a paper, ``papis-zotero`` will add this paper to its\nlibrary instead.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Interact with Zotero using papis",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/papis/papis-zotero"
},
"split_keywords": [
"bibtex",
"biliography",
"cli",
"management",
"papis",
"zotero"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bbe287d2fd72c54ad9d764fcb60d2a2812af820dbeeb3586842eee27241c821",
"md5": "0cf7e125a9e610dbf5ba1909745bfb51",
"sha256": "a3747b15e9b64550252fbf3d4e48365f19a61badfe8020368a8f47aaf6f69086"
},
"downloads": -1,
"filename": "papis-zotero-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0cf7e125a9e610dbf5ba1909745bfb51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16207,
"upload_time": "2023-06-16T11:36:14",
"upload_time_iso_8601": "2023-06-16T11:36:14.999506Z",
"url": "https://files.pythonhosted.org/packages/4b/be/287d2fd72c54ad9d764fcb60d2a2812af820dbeeb3586842eee27241c821/papis-zotero-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 11:36:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "papis",
"github_project": "papis-zotero",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "papis-zotero"
}
JSON
