Pyzotero: a Python client for the Zotero API pyzotero.readthedocs.io
zotero

Merge pull request #236 from urschrei/shugel/push-wtllnzznznqv

Shugel/push wtllnzznznqv

authored by urschrei.eurosky.social and committed by

GitHub 6c8029c1 45561575

+10 -6
+2
.github/workflows/tests.yml
··· 2 2 3 3 on: 4 4 push: 5 + branches: [ main ] 6 + tags: [ '*' ] 5 7 pull_request: 6 8 merge_group: 7 9
+1 -1
README.md
··· 4 4 5 5 # Quickstart 6 6 7 - 1. `pip install pyzotero` **or** `conda config --add channels conda-forge && conda install pyzotero` 7 + 1. `uv add pyzotero` **or** `pip install pyzotero` **or** `conda install conda-forge::pyzotero` 8 8 2. You'll need the ID of the personal or group library you want to access: 9 9 - Your **personal library ID** is available [here](https://www.zotero.org/settings/keys), in the section `Your userID for use in API calls` 10 10 - For **group libraries**, the ID can be found by opening the group's page: `https://www.zotero.org/groups/groupname`, and hovering over the `group settings` link. The ID is the integer after `/groups/`
+7 -5
doc/index.rst
··· 14 14 15 15 Getting started (short version) 16 16 =============================== 17 - 1. In a shell / prompt: ``pip install pyzotero`` or ``conda config --add channels conda-forge && conda install pyzotero`` 17 + 1. ``uv add pyzotero`` or ``pip install pyzotero`` or ``conda install conda-forge::pyzotero`` 18 18 2. You'll need the ID of the personal or group library you want to access: 19 19 20 20 * Your **personal library ID** is available `here <https://www.zotero.org/settings/keys>`_, in the section ``Your userID for use in API calls`` ··· 48 48 ============ 49 49 Installation 50 50 ============ 51 + Using `uv <https://docs.astral.sh/uv/concepts/projects/dependencies/#adding-dependencies>`_: ``uv add pyzotero`` 52 + 51 53 Using `pip <http://www.pip-installer.org/en/latest/index.html>`_: ``pip install pyzotero`` 52 54 53 - Using `Anaconda <https://www.anaconda.com/distribution/>`_: ``conda config --add channels conda-forge && conda install pyzotero`` 55 + Using `Anaconda <https://www.anaconda.com/distribution/>`_: ``conda install conda-forge::pyzotero`` 54 56 55 57 From a local clone, if you wish to install Pyzotero from a specific branch: 56 58 ··· 60 62 git clone git://github.com/urschrei/pyzotero.git 61 63 cd pyzotero 62 64 git checkout main 63 - pip install . 65 + uv sync 64 66 65 67 The Pyzotero source tarball is also available from `PyPI <http://pypi.python.org/pypi/Pyzotero>`_ 66 68 ··· 69 71 =============================== 70 72 Installing development versions 71 73 =============================== 72 - Pyzotero remains in development as of November 2024. Unstable development versions can be found on the `Github main branch <https://github.com/urschrei/pyzotero/tree/main>`_, and installed directly from a checked-out ``main`` branch on a local clone, as in the example above. 74 + Pyzotero remains in development as of 2025. Unstable development versions can be found on the `Github main branch <https://github.com/urschrei/pyzotero/tree/main>`_, and installed directly from a checked-out ``main`` branch on a local clone, as in the example above: specify ``--dev`` (uv) / ``--group dev`` (pip). 73 75 74 76 75 77 ======= 76 78 Testing 77 79 ======= 78 - Testing requires the ``HTTPretty``, and ``Python-Dateutil`` packages. 80 + Testing requires installation of the ``dev`` dependency group (see above). 79 81 80 82 Run ``pytest .`` from the top-level directory. 81 83