sprynger


Namesprynger JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryAn API wrapper for Springer Nature
upload_time2024-11-12 18:35:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords api springer wrapper requests lxml
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. documentation-begin

sprynger: API wrapper for Springer Nature
============================================


Simple API wrapper for the `Springer Nature APIs <https://dev.springernature.com>`_

.. image:: https://badge.fury.io/py/sprynger.svg
    :target: https://pypi.org/project/sprynger/

.. image:: https://img.shields.io/pypi/pyversions/sprynger.svg
    :target: https://pypi.org/project/sprynger/

.. image:: https://readthedocs.org/projects/sprynger/badge/?version=latest
    :target: https://sprynger.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/dm/sprynger.svg
    :target: https://pypi.org/project/sprynger/

.. image:: https://img.shields.io/pypi/l/sprynger.svg
    :target: https://pypi.org/project/sprynger/

.. image:: https://api.codeclimate.com/v1/badges/1d053321a70d800bfc59/maintainability
    :target: https://codeclimate.com/github/your-repo/sprynger/maintainability


🏔️ 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.


⬇️ Install
-----------
Download and install the package from PyPI:

.. code-block:: bash

    pip install sprynger


🪧 Example Use
---------------

.. code:: python
    
    >>> from sprynger import Meta, OpenAccess, init
    >>> init(api_key='your free api key from https://dev.springernature.com')
    >>>
    >>> # Get metadata of all chapters in the book with ISBN '978-3-031-63497-0'
    >>> book_metadata = Metadata(isbn='978-3-031-63497-0', nr_results=3)
    >>> for chapter in book_metadata:
    >>>     print(chapter.identifier)
    >>>     print(chapter.abstract)
    'doi:10.1007/978-3-031-63498-7_20'
        'Modern solvers for quantified Boolean formulas (QBFs) process formulas in prenex form, ...'
    'doi:10.1007/978-3-031-63498-7_9'
        'Given a finite consistent set of ground literals, we present an algorithm that generates ...'
    'doi:10.1007/978-3-031-63498-7_3'
        'The TPTP World is a well established infrastructure that supports research, development, ...'
    >>> # Print the facets of the retrieved chapter's metadata
    >>> book_metadata.facets
    [MetadataFacets(facet='subject', value='Artificial Intelligence', count='27'),...]
    >>> 
    >>> # Retrieve full-text of 'journal articles' with the keyword 'quantum computing' published before 2023
    >>> results = OpenAccess('"quantum computing"', dateto='2022-12-30', type='Journal Article', nr_results=3)
    >>> results.documents_found
    4350
    >>> for document in results:
    >>>    print(document.title)
    >>>    print(document.paragraphs[0].text)
    'A neural network assisted' 
        'A versatile magnetometer must deliver a readable response when exposed to target fields ...'
    'Experimental demonstration of classical analogous time-dependent superposition of states'
        'One of the quantum theory concepts on which quantum information processing stands is superposition ...'
    'A quantum-like cognitive approach to modeling human biased selection behavior'
        'Cognitive biases of the human mind significantly influence the human decision-making process ...'

.. documentation-end

📖 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 A. Herrmann de Alba\" <nils_herrmann@outlook.de>",
    "download_url": "https://files.pythonhosted.org/packages/ed/fb/2b0ae0bad7450e8f0747e4fb0c7b6a71f96ec2acd0d6901a32c89533b35a/sprynger-0.3.1.tar.gz",
    "platform": null,
    "description": ".. documentation-begin\n\nsprynger: API wrapper for Springer Nature\n============================================\n\n\nSimple API wrapper for the `Springer Nature APIs <https://dev.springernature.com>`_\n\n.. image:: https://badge.fury.io/py/sprynger.svg\n    :target: https://pypi.org/project/sprynger/\n\n.. image:: https://img.shields.io/pypi/pyversions/sprynger.svg\n    :target: https://pypi.org/project/sprynger/\n\n.. image:: https://readthedocs.org/projects/sprynger/badge/?version=latest\n    :target: https://sprynger.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/pypi/dm/sprynger.svg\n    :target: https://pypi.org/project/sprynger/\n\n.. image:: https://img.shields.io/pypi/l/sprynger.svg\n    :target: https://pypi.org/project/sprynger/\n\n.. image:: https://api.codeclimate.com/v1/badges/1d053321a70d800bfc59/maintainability\n    :target: https://codeclimate.com/github/your-repo/sprynger/maintainability\n\n\n\ud83c\udfd4\ufe0f Overview Springer Nature\n----------------------------\n\nSpringer Nature currently offers three APIs:\n\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\n\u2b07\ufe0f Install\n-----------\nDownload and install the package from PyPI:\n\n.. code-block:: bash\n\n    pip install sprynger\n\n\n\ud83e\udea7 Example Use\n---------------\n\n.. code:: python\n    \n    >>> from sprynger import Meta, OpenAccess, init\n    >>> init(api_key='your free api key from https://dev.springernature.com')\n    >>>\n    >>> # Get metadata of all chapters in the book with ISBN '978-3-031-63497-0'\n    >>> book_metadata = Metadata(isbn='978-3-031-63497-0', nr_results=3)\n    >>> for chapter in book_metadata:\n    >>>     print(chapter.identifier)\n    >>>     print(chapter.abstract)\n    'doi:10.1007/978-3-031-63498-7_20'\n        'Modern solvers for quantified Boolean formulas (QBFs) process formulas in prenex form, ...'\n    'doi:10.1007/978-3-031-63498-7_9'\n        'Given a finite consistent set of ground literals, we present an algorithm that generates ...'\n    'doi:10.1007/978-3-031-63498-7_3'\n        'The TPTP World is a well established infrastructure that supports research, development, ...'\n    >>> # Print the facets of the retrieved chapter's metadata\n    >>> book_metadata.facets\n    [MetadataFacets(facet='subject', value='Artificial Intelligence', count='27'),...]\n    >>> \n    >>> # Retrieve full-text of 'journal articles' with the keyword 'quantum computing' published before 2023\n    >>> results = OpenAccess('\"quantum computing\"', dateto='2022-12-30', type='Journal Article', nr_results=3)\n    >>> results.documents_found\n    4350\n    >>> for document in results:\n    >>>    print(document.title)\n    >>>    print(document.paragraphs[0].text)\n    'A neural network assisted' \n        'A versatile magnetometer must deliver a readable response when exposed to target fields ...'\n    'Experimental demonstration of classical analogous time-dependent superposition of states'\n        'One of the quantum theory concepts on which quantum information processing stands is superposition ...'\n    'A quantum-like cognitive approach to modeling human biased selection behavior'\n        'Cognitive biases of the human mind significantly influence the human decision-making process ...'\n\n.. documentation-end\n\n\ud83d\udcd6 Documentation\n-----------------\n\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\n---------------------------\n\nIf the package helped you, give it a star!\n\n\u26a0\ufe0f Disclaimer\n--------------\n\nThis project is an independent API wrapper for the Springer Nature API.\nIt 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.3.1",
    "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": "5bfe6c307b483e3cc54681ab915488bffabe867fe81b978b818924183d41f29e",
                "md5": "d579200c7998170333802fb0cffb5c6f",
                "sha256": "4462800ed72ceed0e14c7f13fa5239d7394e0b8c2627054a23d9256b2187b525"
            },
            "downloads": -1,
            "filename": "sprynger-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d579200c7998170333802fb0cffb5c6f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 34819,
            "upload_time": "2024-11-12T18:35:31",
            "upload_time_iso_8601": "2024-11-12T18:35:31.554404Z",
            "url": "https://files.pythonhosted.org/packages/5b/fe/6c307b483e3cc54681ab915488bffabe867fe81b978b818924183d41f29e/sprynger-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "edfb2b0ae0bad7450e8f0747e4fb0c7b6a71f96ec2acd0d6901a32c89533b35a",
                "md5": "603a861c9fd17efe6de49e45f1f97eb8",
                "sha256": "1dd5bbc28488c39e803bcfc6d892be12eaac493b6e521fcc51af6366a7cd8fe1"
            },
            "downloads": -1,
            "filename": "sprynger-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "603a861c9fd17efe6de49e45f1f97eb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 28064,
            "upload_time": "2024-11-12T18:35:33",
            "upload_time_iso_8601": "2024-11-12T18:35:33.115201Z",
            "url": "https://files.pythonhosted.org/packages/ed/fb/2b0ae0bad7450e8f0747e4fb0c7b6a71f96ec2acd0d6901a32c89533b35a/sprynger-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 18:35:33",
    "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"
}
        
Elapsed time: 0.62232s