| Name | pyzotero JSON |
| Version |
1.6.8
JSON |
| download |
| home_page | None |
| Summary | Python wrapper for the Zotero API |
| upload_time | 2025-01-24 00:50:07 |
| maintainer | None |
| docs_url | https://pythonhosted.org/pyzotero/ |
| author | None |
| requires_python | >=3.9 |
| license | # Blue Oak Model License Version 1.0.0 ## Purpose This license gives everyone as much permission to work with this software as possible, while protecting contributors from liability. ## Acceptance In order to receive this license, you must agree to its rules. The rules of this license are both obligations under that agreement and conditions to your license. You must not do anything with this software that triggers a rule that you cannot or will not follow. ## Copyright Each contributor licenses you to do everything with this software that would otherwise infringe that contributor's copyright in it. ## Notices You must ensure that everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license or a link to <https://blueoakcouncil.org/license/1.0.0>. ## Excuse If anyone notifies you in writing that you have not complied with [Notices](#notices), you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, your license ends immediately. ## Patent Each contributor licenses you to do everything with this software that would otherwise infringe any patent claims they can license or become able to license. ## Reliability No contributor can revoke this license. ## No Liability ***As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim.*** |
| keywords |
zotero
dh
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://pypi.python.org/pypi/Pyzotero/) [](http://pyzotero.readthedocs.org/en/latest/?badge=latest) [](https://pypi.python.org/pypi/Pyzotero) [](https://anaconda.org/conda-forge/pyzotero) [](https://pepy.tech/project/pyzotero)
# Pyzotero: An API Client for the Zotero API
# Quickstart
1. `pip install pyzotero` **or** `conda config --add channels conda-forge && conda install pyzotero`
2. You'll need the ID of the personal or group library you want to access:
- Your **personal library ID** is available [here](https://www.zotero.org/settings/keys), in the section `Your userID for use in API calls`
- 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/`
3. You'll also need<sup>†</sup> to get an **API key** [here][2]
4. Are you accessing your own Zotero library? `library_type` is `'user'`
5. Are you accessing a shared group library? `library_type` is `'group'`.
Then:
``` python
from pyzotero import zotero
zot = zotero.Zotero(library_id, library_type, api_key) # local=True for read access to local Zotero
items = zot.top(limit=5)
# we've retrieved the latest five top-level items in our library
# we can print each item's item type and ID
for item in items:
print('Item: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))
```
# Documentation
Full documentation of available Pyzotero methods, code examples, and sample output is available on [Read The Docs][3].
# Installation
* Using [pip][10]: `pip install pyzotero` (it's available as a wheel, and is tested on Python 3.7 and up)
* Using Anaconda:`conda config --add channels conda-forge && conda install pyzotero`
* From a local clone, if you wish to install Pyzotero from a specific branch:
Example:
``` bash
git clone git://github.com/urschrei/pyzotero.git
cd pyzotero
git checkout main
pip install .
```
## Testing
Run `pytest .` from the top-level directory.
## Issues
The latest commits can be found on the [main branch][9], although new features are currently rare. If you encounter an error, please open an issue.
## Pull Requests
Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `dev` branch**.
## Versioning
As of v1.0.0, Pyzotero is versioned according to [Semver](http://semver.org); version increments are performed as follows:
1. MAJOR version will increment with incompatible API changes,
2. MINOR version will increment when functionality is added in a backwards-compatible manner, and
3. PATCH version will increment with backwards-compatible bug fixes.
# Citation
Pyzotero has a DOI:
[](https://zenodo.org/badge/latestdoi/1423403)
You may also cite Pyzotero using [CITATION.cff](CITATION.cff).
A sample citation (APA 6th edition) might look like:
> Stephan Hügel, The Pyzotero Authors (2019, May 18). urschrei/pyzotero: Version v1.3.15. http://doi.org/10.5281/zenodo.2917290
# License
Pyzotero is licensed under the [Blue Oak Model Licence 1.0.0][8]. See [LICENSE.md](LICENSE.md) for details.
[1]: https://www.zotero.org/support/dev/web_api/v3/start
[2]: https://www.zotero.org/settings/keys/new
[3]: http://pyzotero.readthedocs.org/en/latest/
[7]: https://nose2.readthedocs.io/en/latest/
[8]: https://opensource.org/license/blue-oak-model-license
[9]: https://github.com/urschrei/pyzotero/tree/main
[10]: http://www.pip-installer.org/en/latest/index.html
† This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyzotero",
"maintainer": null,
"docs_url": "https://pythonhosted.org/pyzotero/",
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Zotero, DH",
"author": null,
"author_email": "Stephan H\u00fcgel <urschrei@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/67/73/a83742e884ce4c189f694956d636d8326a23aa4ae06b80b6bdff54144fca/pyzotero-1.6.8.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/Pyzotero/) [](http://pyzotero.readthedocs.org/en/latest/?badge=latest) [](https://pypi.python.org/pypi/Pyzotero) [](https://anaconda.org/conda-forge/pyzotero) [](https://pepy.tech/project/pyzotero) \n\n# Pyzotero: An API Client for the Zotero API\n\n# Quickstart\n\n1. `pip install pyzotero` **or** `conda config --add channels conda-forge && conda install pyzotero`\n2. You'll need the ID of the personal or group library you want to access:\n - Your **personal library ID** is available [here](https://www.zotero.org/settings/keys), in the section `Your userID for use in API calls`\n - 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/`\n3. You'll also need<sup>\u2020</sup> to get an **API key** [here][2]\n4. Are you accessing your own Zotero library? `library_type` is `'user'`\n5. Are you accessing a shared group library? `library_type` is `'group'`. \n\nThen:\n\n``` python\nfrom pyzotero import zotero\nzot = zotero.Zotero(library_id, library_type, api_key) # local=True for read access to local Zotero\nitems = zot.top(limit=5)\n# we've retrieved the latest five top-level items in our library\n# we can print each item's item type and ID\nfor item in items:\n print('Item: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))\n```\n\n# Documentation\n\nFull documentation of available Pyzotero methods, code examples, and sample output is available on [Read The Docs][3].\n\n# Installation\n\n* Using [pip][10]: `pip install pyzotero` (it's available as a wheel, and is tested on Python 3.7 and up)\n* Using Anaconda:`conda config --add channels conda-forge && conda install pyzotero`\n* From a local clone, if you wish to install Pyzotero from a specific branch: \n\nExample:\n\n``` bash\ngit clone git://github.com/urschrei/pyzotero.git\ncd pyzotero\ngit checkout main\npip install .\n```\n\n## Testing\n\nRun `pytest .` from the top-level directory.\n\n## Issues\n\nThe latest commits can be found on the [main branch][9], although new features are currently rare. If you encounter an error, please open an issue.\n\n## Pull Requests\n\nPull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `dev` branch**.\n\n## Versioning\n\nAs of v1.0.0, Pyzotero is versioned according to [Semver](http://semver.org); version increments are performed as follows: \n\n\n\n1. MAJOR version will increment with incompatible API changes,\n2. MINOR version will increment when functionality is added in a backwards-compatible manner, and\n3. PATCH version will increment with backwards-compatible bug fixes.\n\n# Citation\n\nPyzotero has a DOI: \n[](https://zenodo.org/badge/latestdoi/1423403) \nYou may also cite Pyzotero using [CITATION.cff](CITATION.cff). \nA sample citation (APA 6th edition) might look like: \n> Stephan H\u00fcgel, The Pyzotero Authors (2019, May 18). urschrei/pyzotero: Version v1.3.15. http://doi.org/10.5281/zenodo.2917290\n\n# License\n\nPyzotero is licensed under the [Blue Oak Model Licence 1.0.0][8]. See [LICENSE.md](LICENSE.md) for details. \n\n[1]: https://www.zotero.org/support/dev/web_api/v3/start\n[2]: https://www.zotero.org/settings/keys/new\n[3]: http://pyzotero.readthedocs.org/en/latest/\n[7]: https://nose2.readthedocs.io/en/latest/\n[8]: https://opensource.org/license/blue-oak-model-license\n[9]: https://github.com/urschrei/pyzotero/tree/main\n[10]: http://www.pip-installer.org/en/latest/index.html\n\u2020 This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.\n\n",
"bugtrack_url": null,
"license": "# Blue Oak Model License Version 1.0.0 ## Purpose This license gives everyone as much permission to work with this software as possible, while protecting contributors from liability. ## Acceptance In order to receive this license, you must agree to its rules. The rules of this license are both obligations under that agreement and conditions to your license. You must not do anything with this software that triggers a rule that you cannot or will not follow. ## Copyright Each contributor licenses you to do everything with this software that would otherwise infringe that contributor's copyright in it. ## Notices You must ensure that everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license or a link to <https://blueoakcouncil.org/license/1.0.0>. ## Excuse If anyone notifies you in writing that you have not complied with [Notices](#notices), you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, your license ends immediately. ## Patent Each contributor licenses you to do everything with this software that would otherwise infringe any patent claims they can license or become able to license. ## Reliability No contributor can revoke this license. ## No Liability ***As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim.*** ",
"summary": "Python wrapper for the Zotero API",
"version": "1.6.8",
"project_urls": {
"Repository": "https://github.com/urschrei/pyzotero",
"Tracker": "https://github.com/urschrei/pyzotero/issues"
},
"split_keywords": [
"zotero",
" dh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82a27fb94aeda2e3d921ba175810a5b7e6deffee6a8403bc4b3226766a2ebcf1",
"md5": "ffa914f75e4cd6262d2176816d2a5b8a",
"sha256": "952716f0c706fafad73a3972357300c3fc11ea6e3b5edc70fa821ad9483ef0a9"
},
"downloads": -1,
"filename": "pyzotero-1.6.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ffa914f75e4cd6262d2176816d2a5b8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26223,
"upload_time": "2025-01-24T00:50:04",
"upload_time_iso_8601": "2025-01-24T00:50:04.788521Z",
"url": "https://files.pythonhosted.org/packages/82/a2/7fb94aeda2e3d921ba175810a5b7e6deffee6a8403bc4b3226766a2ebcf1/pyzotero-1.6.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6773a83742e884ce4c189f694956d636d8326a23aa4ae06b80b6bdff54144fca",
"md5": "6a37438ec4fdfe7eaee97eb543a1826d",
"sha256": "ac22ae59f8b6e216fcabf7f644fbe59a1479f491000b18d9d912b5edc7fc592e"
},
"downloads": -1,
"filename": "pyzotero-1.6.8.tar.gz",
"has_sig": false,
"md5_digest": "6a37438ec4fdfe7eaee97eb543a1826d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 543598,
"upload_time": "2025-01-24T00:50:07",
"upload_time_iso_8601": "2025-01-24T00:50:07.003977Z",
"url": "https://files.pythonhosted.org/packages/67/73/a83742e884ce4c189f694956d636d8326a23aa4ae06b80b6bdff54144fca/pyzotero-1.6.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 00:50:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "urschrei",
"github_project": "pyzotero",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pyzotero"
}
