{
    "info": {
        "author": "Lowell Alleman",
        "author_email": "lowell@kintyre.co",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: End Users/Desktop",
            "Intended Audience :: Information Technology",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: Apache Software License",
            "Natural Language :: English",
            "Operating System :: MacOS :: MacOS X",
            "Operating System :: Microsoft :: Windows",
            "Operating System :: POSIX :: Linux",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Communications",
            "Topic :: Internet",
            "Topic :: System :: Networking :: Monitoring"
        ],
        "description": "Kintyre Speedtest Agent\n-----------------------\n\n[![Build Status](https://travis-ci.org/Kintyre/shinnecock-agent.svg?branch=master)](https://travis-ci.org/Kintyre/shinnecock-agent)\n[![codecov](https://codecov.io/gh/Kintyre/shinnecock-agent/branch/master/graph/badge.svg)](https://codecov.io/gh/Kintyre/ksconf)\n[![PyPI](https://img.shields.io/pypi/v/kintyre-speedtest-agent.svg)](https://pypi.org/project/kintyre-speedtest-agent/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/kintyre-speedtest-agent.svg)](https://pypi.org/project/kintyre-speedtest-agent/)\n\n\nAn Internet speedtest monitoring utility for Splunk HEC.  Speedtest and other networking information\nis captured and sent to a central Splunk instance via the Http Event Collector.  Scheduled\nmonitoring is handled by the OS scheduler of your choice (often cron or the Windows Scheduler).\n\nThe Splunk app and TA are hosted in this [repository][shinnecock-splunk-app] and will be available\nvia Splunkbase.\nThe *Kintyre Speedtest app for Splunk* contains some example searches and visualizations of data\ncollected by this speedtest agent, and the *Kintyre Speedtest add on for Splunk* has an embedded\ncopy of the agent which can be conveniently used for collecting and forwarding speedtest data within\nan existing Splunk infrastructure.\n\n\nInstall\n-------\n\n\nUsing pip:\n\n    pip install kintyre-speedtest-agent\n\nSystem-level install:  (For Mac/Linux)\n\n    curl https://bootstrap.pypa.io/get-pip.py | sudo python - kintyre-speedtest-agent\n\n_Note_: This will also install/update `pip` and work around some known TLS/SSL issues\n\nIf `pip` is not present or out of date on your Linux system, see the Python Packaging doc regarding\n[Linux Package Managers][pip-on-linux].  Or more generally, see [Installing Packages][pypa-tut].\n\n\nConfigure\n---------\n\nConfiguration is handled by a configuration file stored in the user's home directory.\nRun the `--register` command to bootstrap the configuration with appropriate values.\nYou may re-run this process at any time, or edit the kintyre_speedtest.ini file directly.\n\nExample registration command (using the Kintyre's dev server):\n\n    kintyre-speedtest --register \\\n        --url http://splunkspeedtest.dev.kintyre.net:8088 \\\n        --token dbbcd446-f5e7-412b-a971-dae59167a72f\n\nIf your HEC is using HTTPS with a self-signed cert automatically generated by Splunk, then the\nagent will fail with the error `[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed`.\nTo work around this for initial testing, add `--certs insecure` to the `--register` command shown\nabove.  Be sure to enable SSL certificate validation again for a long-term deployment.\n\n*NOTE:* Be sure to run `--register` with the same OS user account used to schedule the execution\n        of speedtest via your scheduler of choice.  Otherwise, the configuration file will not be\n        found and the script will fail.\n\n\nUpgrade\n-------\n\nCheck what version you are running with\n\n    kintyre-speedtest --version\n\nIf it's not the latest version, then upgrade using pip:\n\n    pip install -U kintyre-speedtest-agent\n\n\n\nWhat's collected\n----------------\n\nThe following list documents the types of metrics collected by this agent. Be aware, this is\nonly a summary, not every specific data point.  It is possible that some PII type information \ncould be collected. An example would be if the hostname of your laptop has your name in it. Anyone with\nsecurity concerns should (1) run the script and see a dump of the information it collects, and (2)\nmake sure you trust the endpoint where you are sending this data.  If you have further questions,\nplease review the source code or feel free to ask questions by opening an issue on GitHub.\n\nData points:\n\n * Uniquely assigned UUID.  (If using the Splunk TA version, this is the forwarder's GUID)\n * Speedtest metrics.  (The same data collected by the `speedtest-cli` project in --json output mode)\n   * Bandwidth ratings\n   * External IP address (as issued by the ISP)\n   * Geo IP location\n * Local network interface information (varies by OS and installed CLI tools)\n   * Device name\n   * Wireless SSID, link quality, signal levels, etc.\n   * Hardware address\n   * Driver names and sometimes firmware info\n * Python info\n   * Python version\n   * Processor information\n   * OS/platform name & version\n\nA long-term goal of this project is to provide a means to enable/disable various portions of the\ndata collection process but this is not currently implemented.  If this is important to you, pull\nrequests are always welcomed!\n\n\n\nDevelopers\n----------\n\nIf you wish to help with development, or simply install via git, we suggest installing into a\nvirtual environment that can be thrown away and recreated as necessary.  Pull-requests are welcome!\n\nPrep:\n\n    pip install virtualenv\n\nInstall:\n\n    git clone https://github.com/Kintyre/shinnecock-agent.git\n    cd shinnecock-agent || exit 1\n    virtualenv venv || exit 1\n    souce venv/bin/activate || exit 1\n    pip install -r requirements.txt\n    python setup.py install\n\nTesting locally:\n\n    # Assumes tox and multiple python versions have been installed (i.e., pyenv)\n    tox\n\n    # Accelerated test run bypassing the actual \"SpeedTest\" portion (save some bandwidth)\n    tox -- --fake-it\n\n\n\nCredits\n-------\n\nThis project internally uses:\n\n * [speedtest-cli](https://github.com/sivel/speedtest-cli) - for all Internet performance tests\n * [ifcfg](https://github.com/ftao/python-ifcfg) - for cross-platform network interface enumeration\n * [requests](http://docs.python-requests.org/en/master/) - for posting to the HEC endpoints\n\n\n[pip-on-linux]: https://packaging.python.org/guides/installing-using-linux-tools\n[pypa-tut]: https://packaging.python.org/tutorials/installing-packages\n[shinnecock-splunk-app]: https://github.com/Kintyre/shinnecock-splunk-app\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Kintyre/shinnecock-agent",
        "keywords": "splunk speedtest",
        "license": "Apache Software License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "kintyre-speedtest-agent",
        "package_url": "https://pypi.org/project/kintyre-speedtest-agent/",
        "platform": "",
        "project_url": "https://pypi.org/project/kintyre-speedtest-agent/",
        "project_urls": {
            "Homepage": "https://github.com/Kintyre/shinnecock-agent"
        },
        "release_url": "https://pypi.org/project/kintyre-speedtest-agent/0.3.9/",
        "requires_dist": [
            "six",
            "speedtest-cli",
            "ifcfg (>=0.17.0)",
            "requests",
            "configparser (>=3.5) ; python_version == \"2.7\""
        ],
        "requires_python": "",
        "summary": "Kintyre Shinnecock speedtest agent",
        "version": "0.3.9"
    },
    "last_serial": 5448590,
    "releases": {
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9834d07d649e98eadf11dab10b2fc9fb",
                    "sha256": "e00c8ddb9dec215cad9cd733617a2ad701a5f34787c8e228cad14149309f777a"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9834d07d649e98eadf11dab10b2fc9fb",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 6274,
                "upload_time": "2018-06-20T18:56:11",
                "url": "https://files.pythonhosted.org/packages/db/9e/620261d5b173064c64eea2da8d9d9c0dff4f65eeeee1ef2c4eb628dcdc13/kintyre_speedtest_agent-0.3.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "411113d8302ef49b9a2947fe7793a56a",
                    "sha256": "9b74c0d8b7e0ce498ba5bba9f5b98bb16b796cececb8c2b2567009d7ca93ea25"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "411113d8302ef49b9a2947fe7793a56a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5937,
                "upload_time": "2018-06-20T18:56:14",
                "url": "https://files.pythonhosted.org/packages/2b/31/48c4a0f8cf80081211f153c7387d1369801c1364426040be32aa8d44f0ff/kintyre-speedtest-agent-0.3.0.tar.gz"
            }
        ],
        "0.3.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fc8be3a2a7a754a1639a996051cc5ed5",
                    "sha256": "72b388e1e9f2231a3a8d4180834c42153ed616ff56f0c36eb485d97ff22b2b64"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fc8be3a2a7a754a1639a996051cc5ed5",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 6621,
                "upload_time": "2018-06-29T03:28:08",
                "url": "https://files.pythonhosted.org/packages/95/00/88e90cef5e2e5f11995ffeddcb243e19ac1c2915434ebc7121f68feeca69/kintyre_speedtest_agent-0.3.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a2b9e7e1564de247d948a737a7ad5e28",
                    "sha256": "b6c0a0e078be3b1913cd15224e610fc3198ce8036b03e877409d384fe66a44dc"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.2.tar.gz",
                "has_sig": false,
                "md5_digest": "a2b9e7e1564de247d948a737a7ad5e28",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6437,
                "upload_time": "2018-06-29T03:28:09",
                "url": "https://files.pythonhosted.org/packages/e9/c2/9c86a0432aff33a6e48aebdc1852b45f0d6e4c093664b83a0234abf9452a/kintyre-speedtest-agent-0.3.2.tar.gz"
            }
        ],
        "0.3.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a90a9cdff6d46655a509c88d5ebbc9ab",
                    "sha256": "9cd1c00f46c6c53652bb2a352a9014c7e2132692ddf09d29f7a3bd370f4be70f"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a90a9cdff6d46655a509c88d5ebbc9ab",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8099,
                "upload_time": "2018-07-09T22:05:37",
                "url": "https://files.pythonhosted.org/packages/08/1e/a90f81c3d246ecc06b36ab4bd7887a4074e0514a11bb6b261171fc122593/kintyre_speedtest_agent-0.3.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "61ab1b391564977fa51e6947fd52eedb",
                    "sha256": "b24fa0e60f08c2c7dfda380993471ddfddcb3b918e584a6eac3d0690efac06c0"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.4.tar.gz",
                "has_sig": false,
                "md5_digest": "61ab1b391564977fa51e6947fd52eedb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8242,
                "upload_time": "2018-07-09T22:05:38",
                "url": "https://files.pythonhosted.org/packages/4d/ce/fecd443ed1ddeb050426beba9a0e2bcf39f44c0a76e4e2ef40bb84a64a21/kintyre-speedtest-agent-0.3.4.tar.gz"
            }
        ],
        "0.3.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "475b820616c5fefb7a2c121b6959a2d6",
                    "sha256": "8873aa7c1984fe0a4d2b292974fb7ce2aabad31240753c9aad986a47ed200100"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "475b820616c5fefb7a2c121b6959a2d6",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 11174,
                "upload_time": "2018-07-12T03:57:33",
                "url": "https://files.pythonhosted.org/packages/b5/f0/0c973544a67e469ccd8eb56ac3585347fc8460d3bc2aa8c12060ee3324d7/kintyre_speedtest_agent-0.3.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "aa00b213b5e8c36c391d418f686caede",
                    "sha256": "3506ac91106e78c900bb4c3c74c26dc3a92986ece6c90a79e3972d41b28b16d7"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.5.tar.gz",
                "has_sig": false,
                "md5_digest": "aa00b213b5e8c36c391d418f686caede",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12741,
                "upload_time": "2018-07-12T03:57:34",
                "url": "https://files.pythonhosted.org/packages/a6/3d/bd20dd98ad1ebb2ddb36796387405b8cce826b81fdf297613de069e01f75/kintyre-speedtest-agent-0.3.5.tar.gz"
            }
        ],
        "0.3.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5068e844db6a6a4e4ed8a3b7c8965052",
                    "sha256": "ed4b46ab741dc911e3d18aa2f60b514bafa4a4dc617035f784e9bfb3d91c7165"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.6-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5068e844db6a6a4e4ed8a3b7c8965052",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 12130,
                "upload_time": "2018-07-12T20:29:07",
                "url": "https://files.pythonhosted.org/packages/a8/d8/8dafd85241dfb85111884d961e42360948627d7f0057cff262ad7f28eb36/kintyre_speedtest_agent-0.3.6-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "edb348ecc09df1e78bd81efcf3d8e8e0",
                    "sha256": "7490e9658af50d09c16380f7c2828897337bb51f21b06a1d58a88a97bf658f89"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.6.tar.gz",
                "has_sig": false,
                "md5_digest": "edb348ecc09df1e78bd81efcf3d8e8e0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13803,
                "upload_time": "2018-07-12T20:29:08",
                "url": "https://files.pythonhosted.org/packages/07/d1/cb4e147361a7e1ec2d882b4b8add193d349e6542f48ad42e745e44d44765/kintyre-speedtest-agent-0.3.6.tar.gz"
            }
        ],
        "0.3.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f3f3f472fbd0ce937265defa9a55ee66",
                    "sha256": "15198b7164dc314ee3370279c5804967b31c6bdceb5ca2d682ab56fbba4b2944"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.7-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f3f3f472fbd0ce937265defa9a55ee66",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 12304,
                "upload_time": "2018-07-20T01:40:29",
                "url": "https://files.pythonhosted.org/packages/26/82/0f408ed51a65b0d68159649f4a03cca0f3ff4bb9719dfeb66e23be5b4def/kintyre_speedtest_agent-0.3.7-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "90d1719aedde1914ffabcc16a46106cf",
                    "sha256": "d87ac6ab89175de79896450a955a7e71952e66da49f4a849f6428e6e81794993"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.7.tar.gz",
                "has_sig": false,
                "md5_digest": "90d1719aedde1914ffabcc16a46106cf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13962,
                "upload_time": "2018-07-20T01:40:30",
                "url": "https://files.pythonhosted.org/packages/77/18/254aa9fcec0883ec30a907db51c913dc093c1fc7eb5f28421db228fff479/kintyre-speedtest-agent-0.3.7.tar.gz"
            }
        ],
        "0.3.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7868d98d0c5c80a3194b3c4ed0c05835",
                    "sha256": "b4408df2b49a15020fd62578760104c7f05cf641c85989129ef2ce5bccff6ef8"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.8-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7868d98d0c5c80a3194b3c4ed0c05835",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 12303,
                "upload_time": "2018-09-05T17:00:53",
                "url": "https://files.pythonhosted.org/packages/f3/f7/46e7a7231fce6bc2b3f28d34a0e4ddb307ee9bbb7acacced990320fa3123/kintyre_speedtest_agent-0.3.8-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b7419f570ee6433e1353874de0ee7899",
                    "sha256": "c7932be3fd6f326074ed027a9872a9d33f033aaa82a1e4d7645bb6a1dda8e91e"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.8.tar.gz",
                "has_sig": false,
                "md5_digest": "b7419f570ee6433e1353874de0ee7899",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13958,
                "upload_time": "2018-09-05T17:00:54",
                "url": "https://files.pythonhosted.org/packages/02/67/3ab6138a66f36cebff8d85b1bac9fd8d585aad16c963dbfe6e8f75b3717e/kintyre-speedtest-agent-0.3.8.tar.gz"
            }
        ],
        "0.3.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ccbb3fb24017367bcfb6a57244beb4e3",
                    "sha256": "3e231184acbb5c0d6c1aec98b379983995454d308f80c284e9b2b47c9805b9a7"
                },
                "downloads": -1,
                "filename": "kintyre_speedtest_agent-0.3.9-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ccbb3fb24017367bcfb6a57244beb4e3",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 13461,
                "upload_time": "2019-06-25T21:26:56",
                "url": "https://files.pythonhosted.org/packages/80/40/1a959ebe34ec2e2232ec2f8bdcdd1380be89a21d0a5bdaf850bc52dfdb6c/kintyre_speedtest_agent-0.3.9-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "5f2c41f82534a9e410b5af18c1b50ab3",
                    "sha256": "de518a8b6efb5ee2dcdc998ff4a7ad485eea9832939275ab454d26732ff45dbf"
                },
                "downloads": -1,
                "filename": "kintyre-speedtest-agent-0.3.9.tar.gz",
                "has_sig": false,
                "md5_digest": "5f2c41f82534a9e410b5af18c1b50ab3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16275,
                "upload_time": "2019-06-25T21:26:57",
                "url": "https://files.pythonhosted.org/packages/4d/31/e5646045270575413ccc73e88ab5519243607a4d94b285fd95b884b479a0/kintyre-speedtest-agent-0.3.9.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ccbb3fb24017367bcfb6a57244beb4e3",
                "sha256": "3e231184acbb5c0d6c1aec98b379983995454d308f80c284e9b2b47c9805b9a7"
            },
            "downloads": -1,
            "filename": "kintyre_speedtest_agent-0.3.9-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ccbb3fb24017367bcfb6a57244beb4e3",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 13461,
            "upload_time": "2019-06-25T21:26:56",
            "url": "https://files.pythonhosted.org/packages/80/40/1a959ebe34ec2e2232ec2f8bdcdd1380be89a21d0a5bdaf850bc52dfdb6c/kintyre_speedtest_agent-0.3.9-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5f2c41f82534a9e410b5af18c1b50ab3",
                "sha256": "de518a8b6efb5ee2dcdc998ff4a7ad485eea9832939275ab454d26732ff45dbf"
            },
            "downloads": -1,
            "filename": "kintyre-speedtest-agent-0.3.9.tar.gz",
            "has_sig": false,
            "md5_digest": "5f2c41f82534a9e410b5af18c1b50ab3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16275,
            "upload_time": "2019-06-25T21:26:57",
            "url": "https://files.pythonhosted.org/packages/4d/31/e5646045270575413ccc73e88ab5519243607a4d94b285fd95b884b479a0/kintyre-speedtest-agent-0.3.9.tar.gz"
        }
    ]
}