{
    "info": {
        "author": "Wolfgang Schnerring",
        "author_email": "wolfgang.schnerring@zeit.de",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "==============================================\nPrometheus GitHub vulnerability alert exporter\n==============================================\n\nThis package exports the `Security Vulnerability Alerts`_ from GitHub for all repositories of an organization as `Prometheus`_ metrics.\n\n.. _`Security Vulnerability Alerts`: https://help.github.com/en/categories/managing-security-vulnerabilities\n.. _`Prometheus`: https://prometheus.io\n\n\nUsage\n=====\n\nConfigure API token\n-------------------\n\nYou'll need to provide an access token with scope ``repo`` to access the GitHub API.\nSee the `GitHub documentation` for details.\n\n.. `GitHub documentation`: https://developer.github.com/v4/guides/forming-calls/#authenticating-with-graphql\n\n\nStart HTTP service\n------------------\n\nStart the HTTP server like this::\n\n    $ GITHUB_AUTHTOKEN=MYTOKEN GITHUB_OWNER=MyGitHubOrgOrUser github_vulnerability_exporter --host=127.0.0.1 --port=9597\n\nPass ``--ttl=SECONDS`` to cache GitHub API results for the given time or -1 to disable (default is 600).\nPrometheus considers metrics stale after 300s, so that's the highest scrape_interval one should use.\nHowever it's usually unnecessary to hit the API that often, since the vulnerability alert information does not change that rapidly.\n\nPass ``--forked`` if you want to include forked repositories (not sure if they actually receive vulnerability alerts, though).\n\n\nConfigure Prometheus\n--------------------\n\n::\n\n    scrape_configs:\n      - job_name: 'vulnerabilities'\n        scrape_interval: 1800s\n        static_configs:\n          - targets: ['localhost:9597']\n\nWe export one metric, a gauge called ``github_vulnerability_alerts``,\nwith labels ``{repository=\"MyGitHubOrgOrUser/my-repository-name, status=\"active|dismissed\"}``.\n\nAdditionally, a ``ghvuln_scrape_duration_seconds`` gauge is exported.\n\n\nCHANGES\n=======\n\n\n1.5.0 (2019-06-07)\n------------------\n\n- Add in-memory caching so we don't have to hit the API on each scrape\n\n\n1.4.0 (2019-06-07)\n------------------\n\n- Support collecting data for repositories of either an organization or a user\n\n\n1.3.0 (2019-06-07)\n------------------\n\n- Make listen host configurable\n\n\n1.2.0 (2019-06-07)\n------------------\n\n- Add `status` label to differentiate between active and dismissed alerts\n\n\n1.1.0 (2019-06-07)\n------------------\n\n- Allow configuring via environment variables as well as command line parameters\n\n\n1.0.1 (2019-06-07)\n------------------\n\n- Increase repository query batch size.\n\n\n1.0.0 (2019-06-06)\n------------------\n\n- First release.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ZeitOnline/github_vulnerability_exporter",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "github-vulnerability-exporter",
        "package_url": "https://pypi.org/project/github-vulnerability-exporter/",
        "platform": "",
        "project_url": "https://pypi.org/project/github-vulnerability-exporter/",
        "project_urls": {
            "Homepage": "https://github.com/ZeitOnline/github_vulnerability_exporter"
        },
        "release_url": "https://pypi.org/project/github-vulnerability-exporter/1.5.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "",
        "version": "1.5.0"
    },
    "last_serial": 5372545,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "083e26e0c26301c79dadfc33711dfd67",
                    "sha256": "e303489196e6bccbc1c19ca489af84c9f0146425ebb2c991eac81830fc8b8898"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "083e26e0c26301c79dadfc33711dfd67",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4385,
                "upload_time": "2019-06-06T15:06:13",
                "url": "https://files.pythonhosted.org/packages/da/fb/d86d9009eacd1ab03e8b948daec5b1f8ecafbe21a2ba66c712cb3aeff0c9/github_vulnerability_exporter-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "042ce9bd558605eaf9a44d4ba938fb03",
                    "sha256": "2e6327f15ba79b44b82257dcf78fcbb11d94f09692dff87d7f45f35181b95d99"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "042ce9bd558605eaf9a44d4ba938fb03",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4533,
                "upload_time": "2019-06-07T06:33:28",
                "url": "https://files.pythonhosted.org/packages/44/51/81a1723f277a85d575ea94ecf520f95d76ce56f4ad3d355bf7305f48ae32/github_vulnerability_exporter-1.0.1.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "77720e5daea2762101d280761c31a198",
                    "sha256": "0b9ab465927ccb3cbee87024b099512fd8a31bd6d229dcee28f872fa5830df3b"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "77720e5daea2762101d280761c31a198",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4644,
                "upload_time": "2019-06-07T06:53:43",
                "url": "https://files.pythonhosted.org/packages/3b/2d/76ad67d538e389d7f15b198f4ebd7d4d22ed051ebbc3793f20e91c031791/github_vulnerability_exporter-1.1.0.tar.gz"
            }
        ],
        "1.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7cfc6e1fd79356a60614d1247e2e9706",
                    "sha256": "abce74388710afb5767b803c1973103fa07ca56c641e63917d536cb70c4dec22"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "7cfc6e1fd79356a60614d1247e2e9706",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5076,
                "upload_time": "2019-06-07T09:54:12",
                "url": "https://files.pythonhosted.org/packages/e1/a8/7bc5e0734a364828bd54317cc937de26daf966241abee3cf01bc1c47dc2c/github_vulnerability_exporter-1.2.0.tar.gz"
            }
        ],
        "1.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8a1b4cfde237d04a30414ff8faf5a2ac",
                    "sha256": "454cb4722d347ef3a35043ef3c6c8ff6b4fd79eca8901ecd52ce4fd1c3873269"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8a1b4cfde237d04a30414ff8faf5a2ac",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5119,
                "upload_time": "2019-06-07T16:02:10",
                "url": "https://files.pythonhosted.org/packages/45/9c/5c06bf5c9a2141bc5507628770362fb8b152ad83695204040bf821a53aec/github_vulnerability_exporter-1.3.0.tar.gz"
            }
        ],
        "1.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "95143c158eceb7a151728f490b393ee3",
                    "sha256": "49d0bad9185927572b2591586dfa68ba844d0bd6a844533e8f2e8f422c447ed8"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "95143c158eceb7a151728f490b393ee3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5298,
                "upload_time": "2019-06-07T17:09:33",
                "url": "https://files.pythonhosted.org/packages/9e/b4/0c5bc7ba3e374f336ed5bac628eab9a30704e15537bc100773eeb01cdd5d/github_vulnerability_exporter-1.4.0.tar.gz"
            }
        ],
        "1.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f269f0341132a61e426f233ce2f10931",
                    "sha256": "69aa7088332e2e6975071419ebfe6e6e5ebe2f7aa375f1e37ffcd691fc595f1a"
                },
                "downloads": -1,
                "filename": "github_vulnerability_exporter-1.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f269f0341132a61e426f233ce2f10931",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5725,
                "upload_time": "2019-06-07T17:56:36",
                "url": "https://files.pythonhosted.org/packages/b4/02/551a5e00298a203c27d1495a9e3e28c2eb0f474fa1fe4c8f720f81bcae60/github_vulnerability_exporter-1.5.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f269f0341132a61e426f233ce2f10931",
                "sha256": "69aa7088332e2e6975071419ebfe6e6e5ebe2f7aa375f1e37ffcd691fc595f1a"
            },
            "downloads": -1,
            "filename": "github_vulnerability_exporter-1.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f269f0341132a61e426f233ce2f10931",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5725,
            "upload_time": "2019-06-07T17:56:36",
            "url": "https://files.pythonhosted.org/packages/b4/02/551a5e00298a203c27d1495a9e3e28c2eb0f474fa1fe4c8f720f81bcae60/github_vulnerability_exporter-1.5.0.tar.gz"
        }
    ]
}