| Name | pyzotero JSON |
| Version |
1.5.18
JSON |
| download |
| home_page | |
| Summary | Python wrapper for the Zotero API |
| upload_time | 2023-10-05 10:07:48 |
| maintainer | |
| docs_url | https://pythonhosted.org/pyzotero/ |
| author | |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2015 Stephan Hügel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 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) [](license.txt) [](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)
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 dev
pip install .
```
## Testing
Run `pytest .` from the top-level directory.
## Issues
The latest commits can be found on the [dev 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 [MIT license][8]. See [license.txt](license.txt) 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]: http://opensource.org/licenses/MIT
[9]: https://github.com/urschrei/pyzotero/tree/dev
[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": "",
"name": "pyzotero",
"maintainer": "",
"docs_url": "https://pythonhosted.org/pyzotero/",
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Zotero,DH",
"author": "",
"author_email": "Stephan H\u00fcgel <urschrei@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/0d/7135aa14473d87dacc9299333aece13162c101169a7cd9e9f072fc7f7983/pyzotero-1.5.18.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/Pyzotero/) [](http://pyzotero.readthedocs.org/en/latest/?badge=latest) [](license.txt) [](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)\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 dev\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 [dev 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 [MIT license][8]. See [license.txt](license.txt) 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]: http://opensource.org/licenses/MIT\n[9]: https://github.com/urschrei/pyzotero/tree/dev\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": "The MIT License (MIT) Copyright (c) 2015 Stephan H\u00fcgel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python wrapper for the Zotero API",
"version": "1.5.18",
"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": "76e5cad40df812381ffef3d3bcfb3f54a6d5c74d9ad1775dce8e5feabfb470ff",
"md5": "384a3e175bc2dfcc512943309cd1b881",
"sha256": "c5d461022b00419ea822bad7c9886a6a2770aad49bff607f80e64e81b68212b3"
},
"downloads": -1,
"filename": "pyzotero-1.5.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "384a3e175bc2dfcc512943309cd1b881",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23229,
"upload_time": "2023-10-05T10:07:46",
"upload_time_iso_8601": "2023-10-05T10:07:46.272013Z",
"url": "https://files.pythonhosted.org/packages/76/e5/cad40df812381ffef3d3bcfb3f54a6d5c74d9ad1775dce8e5feabfb470ff/pyzotero-1.5.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "140d7135aa14473d87dacc9299333aece13162c101169a7cd9e9f072fc7f7983",
"md5": "05c44a101f854e18a23c274d0cc6fd0d",
"sha256": "42cecd858703bab49ee92b68ccd1b1d1cbbf85d3f9c889963f352badf8f1a42f"
},
"downloads": -1,
"filename": "pyzotero-1.5.18.tar.gz",
"has_sig": false,
"md5_digest": "05c44a101f854e18a23c274d0cc6fd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 527435,
"upload_time": "2023-10-05T10:07:48",
"upload_time_iso_8601": "2023-10-05T10:07:48.160934Z",
"url": "https://files.pythonhosted.org/packages/14/0d/7135aa14473d87dacc9299333aece13162c101169a7cd9e9f072fc7f7983/pyzotero-1.5.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 10:07:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "urschrei",
"github_project": "pyzotero",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pyzotero"
}
