{
    "info": {
        "author": "Thomas Minier",
        "author_email": "thomas.minier@univ-nantes.fr",
        "bugtrack_url": null,
        "classifiers": [],
        "description": ".. role:: raw-html-m2r(raw)\n   :format: html\n\n\nSage: a SPARQL query engine for public Linked Data providers\n============================================================\n\n\n.. image:: https://travis-ci.com/sage-org/sage-engine.svg?branch=master\n   :target: https://travis-ci.com/sage-org/sage-engine\n   :alt: Build Status\n\n.. image:: https://badge.fury.io/py/sage-engine.svg\n   :target: https://badge.fury.io/py/sage-engine\n   :alt: PyPI version\n\n\nPython implementation of SaGe, a stable, responsive and unrestricted SPARQL query server.\n\nTable of contents\n=================\n\n\n* `Installation <#installation>`_\n* `Getting started <#getting-started>`_\n\n  * `Server configuration <#server-configuration>`_\n  * `Starting the server <#starting-the-server>`_\n\n* `SaGe Docker image <#sage-docker-image>`_\n* `Documentation <#documentation>`_\n\nInstallation\n============\n\nInstallation using pip (with the HDT backend)\n---------------------------------------------\n\nInstallation in a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_ is **strongly advised!**\n\nRequirements:\n\n\n* `pip <https://pip.pypa.io/en/stable/>`_\n* **gcc/clang** with **c++11 support**\n* **Python Development headers**\n  ..\n\n     You should have the ``Python.h`` header available on your system.\n     For example, for Python 3.6, install the ``python3.6-dev`` package on Debian/Ubuntu systems.\n\n\nThe core engine of the SaGe SPARQL query server with `HDT <http://www.rdfhdt.org/>`_ as a backend can be installed as follows:\n\n.. code-block:: bash\n\n   pip install sage-engine[hdt]\n\nManual installation (with the HDT backend)\n------------------------------------------\n\nAdditional requirements:\n\n\n* `git <https://git-scm.com/>`_\n* `npm <https://nodejs.org/en/>`_ (shipped with Node.js on most systems)\n\n.. code-block:: bash\n\n   git clone https://github.com/sage-org/sage-engine\n   cd sage-engine/\n   pip install -r requirements.txt\n   pip install -e .[hdt]\n\nGetting started\n===============\n\nServer configuration\n--------------------\n\nA Sage server is configured using a configuration file in `YAML syntax <http://yaml.org/>`_.\nYou will find below a minimal working example of such configuration file.\nA full example is available `in the ``config_examples/`` directory <https://github.com/sage-org/sage-engine/blob/master/config_examples/example.yaml>`_\n\n.. code-block:: yaml\n\n   name: SaGe Test server\n   maintainer: Chuck Norris\n   quota: 75\n   max_results: 2000\n   datasets:\n   -\n     name: dbpedia\n     description: DBPedia\n     backend: hdt-file\n     file: datasets/dbpedia.2016.hdt\n\nThe ``quota`` and ``max_results`` fields are used to set the maximum time quantum and the maximum number of results\nallowed per request, respectively.\n\nEach entry in the ``datasets`` field declare a RDF dataset with a name, description, backend and options specific to this backend.\nCurrently, **only** the ``hdt-file`` backend is supported, which allow a Sage server to load RDF datasets from `HDT files <http://www.rdfhdt.org/>`_. Sage uses `pyHDT <https://github.com/Callidon/pyHDT>`_ to load and query HDT files.\n\nStarting the server\n-------------------\n\nThe ``sage`` executable, installed alongside the Sage server, allows to easily start a Sage server from a configuration file using `Gunicorn <http://gunicorn.org/>`_\\ , a Python WSGI HTTP Server.\n\n.. code-block:: bash\n\n   # launch Sage server with 4 workers on port 8000\n   sage my_config.yaml -w 4 -p 8000\n\nThe full usage of the ``sage`` executable is detailed below:\n\n.. code-block:: bash\n\n   usage: sage [-h] [-p P] [-w W] [--log-level LEVEL] config\n\n   Launch the Sage server using a configuration file\n\n   positional arguments:\n     config             Path to the configuration file\n\n   optional arguments:\n     -h, --help         show this help message and exit\n     -p P, --port P     The port to bind (default: 8000)\n     -w W, --workers W  The number of server workers (default: 4)\n     --log-level LEVEL  The granularity of log outputs (default: info)\n\nSaGe Docker image\n=================\n\nThe Sage server is also available through a `Docker image <https://hub.docker.com/r/callidon/sage/>`_.\nIn order to use it, do not forget to `mount in the container <https://docs.docker.com/storage/volumes/>`_ the directory that contains you configuration file and your datasets.\n\n.. code-block:: bash\n\n   docker pull callidon/sage\n   docker run -v path/to/config-file:/opt/data/ -p 8000:8000 callidon/sage sage /opt/data/config.yaml -w 4 -p 8000\n\nDocumentation\n=============\n\nTo generate the documentation, you must install the following dependencies\n\n.. code-block:: bash\n\n   pip install sphinx sphinx_rtd_theme sphinxcontrib-httpdomain\n\nThen, navigate in the ``docs`` directory and generate the documentation\n\n.. code-block:: bash\n\n   cd docs/\n   make html\n   open build/html/index.html\n\nCopyright 2017-2019 - `GDD Team <https://sites.google.com/site/gddlina/>`_\\ , `LS2N <https://www.ls2n.fr/?lang=en>`_\\ , `University of Nantes <http://www.univ-nantes.fr/>`_",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/sage-org/sage-engine",
        "keywords": "rdf,sparql,query engine",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sage-engine",
        "package_url": "https://pypi.org/project/sage-engine/",
        "platform": "",
        "project_url": "https://pypi.org/project/sage-engine/",
        "project_urls": {
            "Homepage": "https://github.com/sage-org/sage-engine"
        },
        "release_url": "https://pypi.org/project/sage-engine/2.0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Sage: a SPARQL query engine for public Linked Data providers",
        "version": "2.0.1"
    },
    "last_serial": 5351309,
    "releases": {
        "2.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "79e9732eb6b847e75637c63d9474af34",
                    "sha256": "641e84f1f7b66d3c26705b7b99f1c84b135872f46437e0ba2b82e22fa33e7996"
                },
                "downloads": -1,
                "filename": "sage-engine-2.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "79e9732eb6b847e75637c63d9474af34",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20631122,
                "upload_time": "2019-06-03T08:27:18",
                "url": "https://files.pythonhosted.org/packages/3c/42/223769d9d995e97fb2c27df33994e98b0dcdbc3b32669aacea612048ccd8/sage-engine-2.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "79e9732eb6b847e75637c63d9474af34",
                "sha256": "641e84f1f7b66d3c26705b7b99f1c84b135872f46437e0ba2b82e22fa33e7996"
            },
            "downloads": -1,
            "filename": "sage-engine-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "79e9732eb6b847e75637c63d9474af34",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20631122,
            "upload_time": "2019-06-03T08:27:18",
            "url": "https://files.pythonhosted.org/packages/3c/42/223769d9d995e97fb2c27df33994e98b0dcdbc3b32669aacea612048ccd8/sage-engine-2.0.1.tar.gz"
        }
    ]
}