| Name | sprynger JSON |
| Version |
0.0.0a5
JSON |
| download |
| home_page | None |
| Summary | An API wrapper for Springer Nature |
| upload_time | 2024-09-25 09:41:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
api
springer
wrapper
requests
lxml
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sprynger
Simple API wrapper for the [Springer Nature APIs](https://dev.springernature.com).
## 🏔️ Overview Springer Nature
Springer Nature currently offers three APIs:
- **Springer Metadata API:** Metadata of articles, journal articles and book chapters.
- **Springer Meta API:** Advanced version offering versioned metadata.
- **Springer OpenAccess API:** Metadata and, where available, full-text
**Note:** sprynger currently supports the Metadata and OpenAccess API
## 🪧 Example
<div style="font-size: 12px;">
### Metadata
```py
from sprynger import DocumentMetadata, Metadata, init
init()
```
```py
article = DocumentMetadata('10.1007/s10660-023-09761-x')
article.metadata
```
> MetadataRecord(contentType='Article', identifier='doi:10.1007/s10660-023-09761-x', language='en', ...)
```py
book_metadata = Metadata('978-3-030-43582-0')
for record in book_metadata:
print(record)
```
> MetadataRecord(contentType='Chapter', title='Explanations of Machine Learning', abstract='There is an unavoidable tension...',...
> MetadataRecord(contentType='Chapter', title='From Holmes to AlphaGo', abstract='Holmes’s enduring interest was in the...',...
> ...
### OpenAccess
```py
from sprynger import OpenAccessArticle, OpenAccessChapter, OpenAccessJournal, OpenAccessBook
article = OpenAccessArticle('10.1007/s10288-023-00561-5')
article.paragraphs[0]
```
> OpenAcessParagraph(paragraph_id='Par2', ..., text='Continuing the first part of this paper, in which we provided a brief survey of the state of the art in multiple criteria decision aiding (MCDA)...')
```py
journal = OpenAccessJournal('2198-6053')
for article in journal:
print(article.metadata)
```
> ArticleMeta(article_type='correction', language='en', publisher_id='s40747-0...
> ArticleMeta(article_type='research-article', language='en', publisher_id='s40...
> ...
```py
book = OpenAccessBook("978-3-031-63500-7", start=1, max_results=2, refresh=30)
for chapter in book:
print(chapter.metadata)
```
> ChapterMeta(doi='10.1007/978-3-031-63501-4_13', chapter='13')
> ChapterMeta(doi='10.1007/978-3-031-63501-4_18', chapter='18')
</div>
## 📖 Documentation
For a comprehensive guide, see the documentation in [read the docs](https://sprynger.readthedocs.io/en/latest/index.html).
## ⭐️ Give the package a star
If the package helped you, give it a star!
## ⚠️ Disclaimer
This project is an independent API wrapper for the Springer Nature API. It is not affiliated with, endorsed, or maintained by Springer Nature. For official support, please refer to the Springers's [documentation](http://docs-dev.springernature.com/docs/) and support channels.
Raw data
{
"_id": null,
"home_page": null,
"name": "sprynger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "API, Springer, wrapper, requests, lxml",
"author": null,
"author_email": "Nils Herrmann <nils_herrmann@outlook.de>",
"download_url": "https://files.pythonhosted.org/packages/6b/58/5c0dd69d5668c10e94c8cdb33aeed7ae84a1610fda6ae01080b7c75a2daa/sprynger-0.0.0a5.tar.gz",
"platform": null,
"description": "# sprynger\nSimple API wrapper for the [Springer Nature APIs](https://dev.springernature.com).\n\n\n\n\n\n\n\n\n## \ud83c\udfd4\ufe0f Overview Springer Nature\nSpringer Nature currently offers three APIs:\n- **Springer Metadata API:** Metadata of articles, journal articles and book chapters.\n- **Springer Meta API:** Advanced version offering versioned metadata.\n- **Springer OpenAccess API:** Metadata and, where available, full-text\n\n**Note:** sprynger currently supports the Metadata and OpenAccess API\n\n## \ud83e\udea7 Example\n<div style=\"font-size: 12px;\">\n\n### Metadata\n```py\nfrom sprynger import DocumentMetadata, Metadata, init\ninit()\n```\n```py\narticle = DocumentMetadata('10.1007/s10660-023-09761-x')\narticle.metadata\n```\n> MetadataRecord(contentType='Article', identifier='doi:10.1007/s10660-023-09761-x', language='en', ...)\n\n```py\nbook_metadata = Metadata('978-3-030-43582-0')\nfor record in book_metadata:\n print(record)\n```\n> MetadataRecord(contentType='Chapter', title='Explanations of Machine Learning', abstract='There is an unavoidable tension...',... \n> MetadataRecord(contentType='Chapter', title='From Holmes to AlphaGo', abstract='Holmes\u2019s enduring interest was in the...',... \n> ...\n\n\n### OpenAccess\n```py\nfrom sprynger import OpenAccessArticle, OpenAccessChapter, OpenAccessJournal, OpenAccessBook\n\narticle = OpenAccessArticle('10.1007/s10288-023-00561-5')\narticle.paragraphs[0]\n```\n> OpenAcessParagraph(paragraph_id='Par2', ..., text='Continuing the first part of this paper, in which we provided a brief survey of the state of the art in multiple criteria decision aiding (MCDA)...')\n\n```py\njournal = OpenAccessJournal('2198-6053')\nfor article in journal:\n print(article.metadata)\n```\n> ArticleMeta(article_type='correction', language='en', publisher_id='s40747-0... \n> ArticleMeta(article_type='research-article', language='en', publisher_id='s40... \n> ...\n\n```py\nbook = OpenAccessBook(\"978-3-031-63500-7\", start=1, max_results=2, refresh=30)\nfor chapter in book:\n print(chapter.metadata)\n```\n> ChapterMeta(doi='10.1007/978-3-031-63501-4_13', chapter='13') \n> ChapterMeta(doi='10.1007/978-3-031-63501-4_18', chapter='18')\n\n</div>\n\n## \ud83d\udcd6 Documentation\nFor a comprehensive guide, see the documentation in [read the docs](https://sprynger.readthedocs.io/en/latest/index.html).\n\n## \u2b50\ufe0f Give the package a star\nIf the package helped you, give it a star!\n\n## \u26a0\ufe0f Disclaimer\nThis project is an independent API wrapper for the Springer Nature API. It is not affiliated with, endorsed, or maintained by Springer Nature. For official support, please refer to the Springers's [documentation](http://docs-dev.springernature.com/docs/) and support channels.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An API wrapper for Springer Nature",
"version": "0.0.0a5",
"project_urls": {
"Documentation": "https://sprynger.readthedocs.io/en/latest/",
"Homepage": "https://github.com/nils-herrmann/sprynger",
"Issues": "https://github.com/nils-herrmann"
},
"split_keywords": [
"api",
" springer",
" wrapper",
" requests",
" lxml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f631de69d09c55f88b3886d6b720147f264a2bfb7c63ee3b14680d43064c1af5",
"md5": "cba7cd3726278dc7bb0298debb92eded",
"sha256": "0e3317f8bc0be1a28198ad091f5841eaebf2628979a46a4af4bb9c356d6269f9"
},
"downloads": -1,
"filename": "sprynger-0.0.0a5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cba7cd3726278dc7bb0298debb92eded",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26651,
"upload_time": "2024-09-25T09:41:17",
"upload_time_iso_8601": "2024-09-25T09:41:17.765989Z",
"url": "https://files.pythonhosted.org/packages/f6/31/de69d09c55f88b3886d6b720147f264a2bfb7c63ee3b14680d43064c1af5/sprynger-0.0.0a5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b585c0dd69d5668c10e94c8cdb33aeed7ae84a1610fda6ae01080b7c75a2daa",
"md5": "e439b9e6cb538e57e7181a7dff2c87e5",
"sha256": "903c3ee6717b477e2b4d1481edfbc665f3a40082bdc313aa6b53526c114b9f3b"
},
"downloads": -1,
"filename": "sprynger-0.0.0a5.tar.gz",
"has_sig": false,
"md5_digest": "e439b9e6cb538e57e7181a7dff2c87e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20781,
"upload_time": "2024-09-25T09:41:18",
"upload_time_iso_8601": "2024-09-25T09:41:18.992741Z",
"url": "https://files.pythonhosted.org/packages/6b/58/5c0dd69d5668c10e94c8cdb33aeed7ae84a1610fda6ae01080b7c75a2daa/sprynger-0.0.0a5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 09:41:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nils-herrmann",
"github_project": "sprynger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sprynger"
}
