{
    "info": {
        "author": "European XFEL GmbH",
        "author_email": "cas-support@xfel.eu",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: BSD License",
            "Operating System :: POSIX :: Linux",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6"
        ],
        "description": "===========================\nEuropean XFEL Karabo Bridge\n===========================\n\n.. image:: https://travis-ci.org/European-XFEL/karabo-bridge-py.svg?branch=master\n  :target: https://travis-ci.org/European-XFEL/karabo-bridge-py\n\n.. image:: https://codecov.io/gh/European-XFEL/karabo-bridge-py/branch/master/graph/badge.svg\n  :target: https://codecov.io/gh/European-XFEL/karabo-bridge-py\n\n\n\n``karabo_bridge`` is a Python 3 client to receive pipeline data from the\nKarabo control system used at `European XFEL <https://www.xfel.eu/>`_.\nA simulated Karabo bridge server is included to allow testing code without\na connection to a real Karabo server.\n\nInstalling\n----------\n\nto install the package::\n\n    $ python3 -m pip install karabo-bridge\n\n    or\n\n    $ git clone https://github.com/European-XFEL/karabo-bridge-py.git\n    $ cd ./karabo-bridge-py\n    $ python3 -m pip install .\n\nHow to use\n----------\n\nRequest data from a karabo bridge server\n++++++++++++++++++++++++++++++++++++++++\n\nUse the ``Client`` class from karabo_brige to create a client and the\n``next`` method to request data from the server.\nThe function returns 2 dictionaries: the first one holds a train data and the\nsecond one holds the associated train metadata. Both dictionaries are keyed by\nsource name, and the values are dictionaries containing parameters name and\nvalues for data and metadata information (source name, timestamp, trainId)\nfor the metadata. Values are all built-in python types, or numpy arrays.\n\n.. code-block:: python\n\n    >>> from karabo_bridge import Client\n    >>> krb_client = Client('tcp://server-host-name:12345')\n    >>> data, metadata = krb_client.next()\n    >>> data.keys()\n    dict_keys(['source1', 'source2', 'source3'])\n    >>> data['source1'].keys()\n    dict_keys(['param1', 'param2'])\n    >>> metadata['source1']\n    {'source1': {'source': 'source1',\n      'timestamp': 1528476983.744877,\n      'timestamp.frac': '744877000000000000',\n      'timestamp.sec': '1528476983',\n      'timestamp.tid': 10000000073}}\n\nUse the Simulation server\n+++++++++++++++++++++++++\n\nTo start a simulation, call the ``start_gen`` function and provide a port to\nbind to. You can the use the ``Client`` class and connect to it to test the\nclient without the need to use Karabo.\n\n.. code-block:: python\n\n    >>> from karabo_bridge import start_gen\n    >>> start_gen(1234)\n    Server : emitted train: 10000000000\n    Server : emitted train: 10000000001\n    Server : emitted train: 10000000002\n    Server : emitted train: 10000000003\n    Server : emitted train: 10000000004\n    ...\n\n\nYou can also run the simulated server from the command line::\n\n    $ karabo-bridge-server-sim 1234\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/European-XFEL/karabo-bridge-py",
        "keywords": "",
        "license": "BSD-3-Clause",
        "maintainer": "Thomas Michelat",
        "maintainer_email": "",
        "name": "karabo-bridge",
        "package_url": "https://pypi.org/project/karabo-bridge/",
        "platform": "",
        "project_url": "https://pypi.org/project/karabo-bridge/",
        "project_urls": {
            "Homepage": "https://github.com/European-XFEL/karabo-bridge-py"
        },
        "release_url": "https://pypi.org/project/karabo-bridge/0.4.0/",
        "requires_dist": [
            "msgpack (>=0.5.4)",
            "msgpack-numpy",
            "numpy",
            "pyzmq (>=17.0.0)",
            "pytest; extra == 'test'",
            "pytest-cov; extra == 'test'",
            "h5py; extra == 'test'",
            "testpath; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "Python 3 tools to request data from the Karabo controlsystem.",
        "version": "0.4.0"
    },
    "last_serial": 5945166,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2d41ec121a06779e43b77a4dcdba7571",
                    "sha256": "03564c8c2183ea2730d3addc1946f563e3afab7d79ab9b059240e17eb5976546"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2d41ec121a06779e43b77a4dcdba7571",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 14680,
                "upload_time": "2018-06-12T12:39:15",
                "url": "https://files.pythonhosted.org/packages/2c/0e/08125bef70811434045f8c5b8e38f8bed64d147cdc45a352b7be7bbad991/karabo_bridge-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a9e4452f93a6ae904725df59796e0443",
                    "sha256": "8cc044a4f8c9fe7205a895c4ecf7e1527186198207ad1005caf15a87713a6398"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a9e4452f93a6ae904725df59796e0443",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11002,
                "upload_time": "2018-06-12T12:39:17",
                "url": "https://files.pythonhosted.org/packages/a8/4b/88f03f8226aa7dca1b605193664df093ed4eaff3571e408b46540ca1b501/karabo_bridge-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "650eefb487de57b46a79500d6846809f",
                    "sha256": "cadc6469c4b46a509869a88b0014016eb1cf8400552a35006b6a204d72c00151"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "650eefb487de57b46a79500d6846809f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13546,
                "upload_time": "2018-08-09T07:42:02",
                "url": "https://files.pythonhosted.org/packages/be/3a/63a361afe60eca0fea4b4b677818f0136332889730c8b5adca0ac72845db/karabo_bridge-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "aec551f5efc24d197bf7f236fb0fc668",
                    "sha256": "08a83cde07d94f354caad085b71cc23a81ee9fa2106eb9043fd8358e22dcaf38"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "aec551f5efc24d197bf7f236fb0fc668",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11810,
                "upload_time": "2018-08-09T07:42:03",
                "url": "https://files.pythonhosted.org/packages/33/52/5cc9eed9bd2610c751d8135214743142f5d4246c99f203dc2b1029bee3d0/karabo_bridge-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9eb47e73f142346dfc219e15568a59c7",
                    "sha256": "72cd8534b7c1987bab8266da247bd8fdb1e460eb434b59a8764aa5868834639a"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "9eb47e73f142346dfc219e15568a59c7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13392,
                "upload_time": "2019-04-09T15:13:38",
                "url": "https://files.pythonhosted.org/packages/da/d3/5f1707e0a4f73675bf99e9f898829b19066c715727b6850949ed7c7621bb/karabo_bridge-0.3.0.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a163ce76bc453a6a399f1bd52f3cb2df",
                    "sha256": "8e485bad51250eedca7ac1bde07d960713403a65261b44da7c7746a6ce25512f"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.4.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a163ce76bc453a6a399f1bd52f3cb2df",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 14414,
                "upload_time": "2019-10-08T14:43:42",
                "url": "https://files.pythonhosted.org/packages/cb/7d/ca44f80a4d2ecaec01e19673424781265b90e416357b1e18cd57589f31b2/karabo_bridge-0.4.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d11881b901cbeeb54344b76a8ff4f37f",
                    "sha256": "f8712d25496328428206ece86c8047972b0bd7d16ced010d09dae143428d2f45"
                },
                "downloads": -1,
                "filename": "karabo_bridge-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d11881b901cbeeb54344b76a8ff4f37f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13118,
                "upload_time": "2019-10-08T14:43:44",
                "url": "https://files.pythonhosted.org/packages/70/1e/f2cf003b4e60d9da394f95f8e259fa7bad87dbc59bec394c99e04652125a/karabo_bridge-0.4.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a163ce76bc453a6a399f1bd52f3cb2df",
                "sha256": "8e485bad51250eedca7ac1bde07d960713403a65261b44da7c7746a6ce25512f"
            },
            "downloads": -1,
            "filename": "karabo_bridge-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a163ce76bc453a6a399f1bd52f3cb2df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14414,
            "upload_time": "2019-10-08T14:43:42",
            "url": "https://files.pythonhosted.org/packages/cb/7d/ca44f80a4d2ecaec01e19673424781265b90e416357b1e18cd57589f31b2/karabo_bridge-0.4.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d11881b901cbeeb54344b76a8ff4f37f",
                "sha256": "f8712d25496328428206ece86c8047972b0bd7d16ced010d09dae143428d2f45"
            },
            "downloads": -1,
            "filename": "karabo_bridge-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d11881b901cbeeb54344b76a8ff4f37f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13118,
            "upload_time": "2019-10-08T14:43:44",
            "url": "https://files.pythonhosted.org/packages/70/1e/f2cf003b4e60d9da394f95f8e259fa7bad87dbc59bec394c99e04652125a/karabo_bridge-0.4.0.tar.gz"
        }
    ]
}