ebel-rest


Nameebel-rest JSON
Version 1.0.25 PyPI version JSON
download
home_page
Summarye(BE:L) API client
upload_time2023-06-15 11:34:25
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT
keywords api bel knowledge graph orientdb
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            e(BE:L) RESTful API Client |build| |coverage|
==================================================

**e(BE:L) RESTful API Client** is a client for the easy usage of API methods provided be an e(BE:L) knowledge server.
e(BE:L) is currently in the alpha-testing phase and will be released soon!


Installation |python_versions| |pypi| |pypi_license|
------------------------------------------------------

.. code-block:: sh

    $ pip install ebel_rest


Quick Start
------------

Connect to the database using the credentials.

.. code-block:: python

    from ebel_rest import connect, query

    # Database settings
    server = "https://graphstore.scai.fraunhofer.de"
    db_name = "covid"
    user = "guest"
    password = "guest"
    print_url = True

    # Connect to database
    connect(user, password, server, db_name, print_url)

Start making queries

.. code-block:: python

    pubs = statistics.publication_by_year()
    pubs.data

Usage
--------
This API interface package is designed to simplify communicating with an e(BE:L) generated knowledge graph. Examples
of how to use this package and its methods can be found in
`Examples notebook <https://github.com/e-bel/ebel_rest/blob/master/notebooks/Examples.ipynb>`_.


Disclaimer
----------

The COVID-19 Knowledge Graph is a resource developed in an academic capacity funded by the
`PHAGO project <https://www.phago.eu/home/>`_ and thus comes with no warranty or guarantee of maintenance or support.


.. |pypi| image:: https://img.shields.io/pypi/v/ebel_rest.svg
        :target: https://pypi.python.org/pypi/ebel_rest

.. |travis| image:: https://img.shields.io/travis/e-bel/ebel_rest.svg
        :target: https://travis-ci.org/cebel/ebel_rest

.. |docs| image:: https://readthedocs.org/projects/ebel-rest/badge/?version=latest
        :target: https://ebel-rest.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. |pypi_license| image:: https://img.shields.io/pypi/l/ebel_rest.svg
    :target: https://pypi.python.org/pypi/ebel_rest
    :alt: MIT License

.. |python_versions| image:: https://img.shields.io/pypi/pyversions/ebel_rest.svg
    :alt: Stable Supported Python Versions

.. |coverage| image:: https://codecov.io/gh/e-bel/ebel_rest/coverage.svg?branch=master
    :target: https://codecov.io/gh/e-bel/ebel_rest?branch=master
    :alt: Coverage Status

.. |build| image:: https://travis-ci.com/e-bel/ebel_rest.svg?branch=master
    :target: https://travis-ci.com/e-bel/ebel_rest
    :alt: Build Status
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ebel-rest",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Christian Ebeling <christian.ebeling@scai.fraunhofer.de>",
    "keywords": "API,BEL,Knowledge Graph,OrientDB",
    "author": "",
    "author_email": "Bruce Schultz <bruce.schultz@scai.fraunhofer.de>, Christian Ebeling <christian.ebeling@scai.fraunhofer.de>",
    "download_url": "https://files.pythonhosted.org/packages/e2/be/9c6110c1a455bbd4c8b490e9aa29f6756c5adc17216ce3653ce7d618e852/ebel_rest-1.0.25.tar.gz",
    "platform": null,
    "description": "e(BE:L) RESTful API Client |build| |coverage|\n==================================================\n\n**e(BE:L) RESTful API Client** is a client for the easy usage of API methods provided be an e(BE:L) knowledge server.\ne(BE:L) is currently in the alpha-testing phase and will be released soon!\n\n\nInstallation |python_versions| |pypi| |pypi_license|\n------------------------------------------------------\n\n.. code-block:: sh\n\n    $ pip install ebel_rest\n\n\nQuick Start\n------------\n\nConnect to the database using the credentials.\n\n.. code-block:: python\n\n    from ebel_rest import connect, query\n\n    # Database settings\n    server = \"https://graphstore.scai.fraunhofer.de\"\n    db_name = \"covid\"\n    user = \"guest\"\n    password = \"guest\"\n    print_url = True\n\n    # Connect to database\n    connect(user, password, server, db_name, print_url)\n\nStart making queries\n\n.. code-block:: python\n\n    pubs = statistics.publication_by_year()\n    pubs.data\n\nUsage\n--------\nThis API interface package is designed to simplify communicating with an e(BE:L) generated knowledge graph. Examples\nof how to use this package and its methods can be found in\n`Examples notebook <https://github.com/e-bel/ebel_rest/blob/master/notebooks/Examples.ipynb>`_.\n\n\nDisclaimer\n----------\n\nThe COVID-19 Knowledge Graph is a resource developed in an academic capacity funded by the\n`PHAGO project <https://www.phago.eu/home/>`_ and thus comes with no warranty or guarantee of maintenance or support.\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ebel_rest.svg\n        :target: https://pypi.python.org/pypi/ebel_rest\n\n.. |travis| image:: https://img.shields.io/travis/e-bel/ebel_rest.svg\n        :target: https://travis-ci.org/cebel/ebel_rest\n\n.. |docs| image:: https://readthedocs.org/projects/ebel-rest/badge/?version=latest\n        :target: https://ebel-rest.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. |pypi_license| image:: https://img.shields.io/pypi/l/ebel_rest.svg\n    :target: https://pypi.python.org/pypi/ebel_rest\n    :alt: MIT License\n\n.. |python_versions| image:: https://img.shields.io/pypi/pyversions/ebel_rest.svg\n    :alt: Stable Supported Python Versions\n\n.. |coverage| image:: https://codecov.io/gh/e-bel/ebel_rest/coverage.svg?branch=master\n    :target: https://codecov.io/gh/e-bel/ebel_rest?branch=master\n    :alt: Coverage Status\n\n.. |build| image:: https://travis-ci.com/e-bel/ebel_rest.svg?branch=master\n    :target: https://travis-ci.com/e-bel/ebel_rest\n    :alt: Build Status",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "e(BE:L) API client",
    "version": "1.0.25",
    "project_urls": {
        "repository": "https://github.com/e-bel/ebel_rest"
    },
    "split_keywords": [
        "api",
        "bel",
        "knowledge graph",
        "orientdb"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dea4318c31cf34e73968ef6f24221804c2e100bb439140a1856a5d04dc465478",
                "md5": "ca72dec27bfa7303b45f6fefbb4878e0",
                "sha256": "9fe8c601b08d35b966046123fe15d38728aced1c2773c99eb3433534e0f5c473"
            },
            "downloads": -1,
            "filename": "ebel_rest-1.0.25-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ca72dec27bfa7303b45f6fefbb4878e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 13636,
            "upload_time": "2023-06-15T11:34:23",
            "upload_time_iso_8601": "2023-06-15T11:34:23.486782Z",
            "url": "https://files.pythonhosted.org/packages/de/a4/318c31cf34e73968ef6f24221804c2e100bb439140a1856a5d04dc465478/ebel_rest-1.0.25-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2be9c6110c1a455bbd4c8b490e9aa29f6756c5adc17216ce3653ce7d618e852",
                "md5": "f8b1d8af9154b30c9e08c41799dfa746",
                "sha256": "c9ad62262a5886d9371111c5bca8d383c672baad1e07efed2e8bd22ddbffbd25"
            },
            "downloads": -1,
            "filename": "ebel_rest-1.0.25.tar.gz",
            "has_sig": false,
            "md5_digest": "f8b1d8af9154b30c9e08c41799dfa746",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 1088856,
            "upload_time": "2023-06-15T11:34:25",
            "upload_time_iso_8601": "2023-06-15T11:34:25.388396Z",
            "url": "https://files.pythonhosted.org/packages/e2/be/9c6110c1a455bbd4c8b490e9aa29f6756c5adc17216ce3653ce7d618e852/ebel_rest-1.0.25.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-15 11:34:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "e-bel",
    "github_project": "ebel_rest",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "ebel-rest"
}
        
Elapsed time: 0.57940s