{
    "info": {
        "author": "code-inspector",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy",
            "Topic :: Software Development :: Testing"
        ],
        "description": "[![Code Grade](https://www.code-inspector.com/project/183/status/svg)](https://www.code-inspector.com/public/project/183/Code%20Inspector%20CI%20Tools/dashboard)\n\n\n# Code-Inspector Continuous Integration Tool\n\n\nThese are various Python tools used to use the [code-inspector](https://www.code-inspector.com)\nengine in a continuous integration pipeline and compare analysis.\n\nThe following programs are being included:\n\n * `code-inspector-project`: get metrics about a project\n * `code-inspector-compare`: compare a project metrics against another projects or branches\n\n\n## Build\n\nYou can build and try the program using the following command:\n\n```bash\npython setup.py install --user\n```\n\nYou will then find binaries in `$HOME/.local/bin`, for example `$HOME/.local/bin/code-inspector-compare`.\n\n## Usage\n\nYou need to set your API keys with environment variables:\n\n * `CODE_INSPECTOR_ACCESS_KEY`: your access key API generated from your project preferences\n * `CODE_INSPECTOR_SECRET_KEY`: your secret key API generated from your project preferences\n\nOn a terminal, you would set them up like this:\n```bash\nexport CODE_INSPECTOR_ACCESS_KEY=<INSERT-YOUR-API-ACCESS-KEY-HERE>\nexport CODE_INSPECTOR_SECRET_KEY=<INSERT-YOUR-API-SECRET-KEY-HERE>\n```\n\n### Project information tool\n\nGet general information about a project.\n\nInvoke the tool as follow:\n\n```bash\ncode-inspector-project -p <PROJECT_NAME>\n```\n\nFor example:\n\n```bash\ncode-inspector-project -p \"mergify integration\"\n```\n\nThis is an example of the execution results:\n\n```\n{\n    \"lastAnalysis\": {\n        \"status\": \"Done\", \n        \"summary\": {\n            \"duplicates\": 0, \n            \"duplicated_lines\": 0, \n            \"violations\": 2\n        }\n    }, \n    \"id\": 173, \n    \"name\": \"mergify integration\"\n}\n```\n\n\n### Compare tool\n\nThe compare tool is used to compare a project with another repository. \nInvoke the tool as follow:\n\n```bash\ncode-inspector-compare -p \"mergify integration\" --kind <REPOSITORY_KIND> --url <URL_TO_OTHER_REPOSITORY> --target-branch=<BRANCH> --target-revision=<REVISION>\n```\n\nThis command will compare the project `mergify integration` on code inspector with the project located\nat the URL `<URL_TO_OTHER_REPOSITORY>`.\n\nWhen the tool successfully executes, it reports the execution in a JSON object.\nThis object shows you the number of violations, duplicates so that developers can\nreuse this later.\nThere is an example of the JSON object - as follow:\n\n```\n{\n    \"status\": \"Done\", \n    \"targetAnalysis\": {\n        \"status\": \"Done\", \n        \"summary\": {\n            \"duplicates\": 0, \n            \"violations\": 2\n        }\n    }, \n    \"id\": 53, \n    \"sourceAnalysis\": {\n        \"status\": \"Done\", \n        \"summary\": {\n            \"duplicates\": 0, \n            \"violations\": 2\n        }\n    }\n}\n```\n\nThese are the explanation for the other parameters:\n * `kind`: kind of repository used for the target. Can be `Git`, `Github`, `Gitlab` or `Bitbucket`. Values are explained below. This parameter is **REQUIRED**.\n * `URL`: URL of the repository. This parameter is **REQUIRED**.\n * `target-revision`: revision of the target repository. This parameter is **OPTIONAL**\n * `target-branch`: branch of the target repository. This parameter is **OPTIONAL**\n\n\nThe `kind` argument is used to define how the target repository will be fetched.\nBased on the value, we use credentials from the authenticated user to clone the repository.\nFor example, if you specify `Github`, the target repository will be cloned using the github credentials\nof the authenticated user. If the user does not have any registered credentials on [Code Inspector](https://www.code-inspector.com),\nanalysis will fail.\n\nThese are the valid values for the `kind` argument:\n\n * `Github`: use the Github credentials of the user making the compare request to clone the target repository\n * `Git`: do not use any credentials to clone the target repository. Used to clone public repository that does not need authentication.\n * `Gitlab`: use the Gitlab credentials of the user making the compare request to clone the target repository\n * `Bitbucket`: use the Bitbucket credentials of the user making the compare request to clone the target repository\n\n\nThese are the potential return code:\n * `0`: everything is great and the target analysis does not have more violations or duplicates\n * `1`: error during the analysis\n * `2`: cannot find the project (specified with the `-p` option)\n * `3`: cannot start a new comparison\n * `5`: the target analysis has more violations than the source\n * `6`: the target analysis has more duplicates than the source\n\n\n## About Code Inspector\n\n[Code Inspector](https://www.code-inspector.com) is a software analysis platform to manage and mitigate\ntechnical debt. It offers plans that caters to all developers. From our basic free plan for your personal project\nto the gold plan (for companies with multiples private projects), [code-inspector](https://www.code-inspector.com) detects coding issues\nand helps you keep your project afloat.\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/codeinspectorio/citool",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "code-inspector",
        "package_url": "https://pypi.org/project/code-inspector/",
        "platform": "",
        "project_url": "https://pypi.org/project/code-inspector/",
        "project_urls": {
            "Changelog": "https://github.com/codeinspectorio/citool/blob/master/CHANGELOG.md",
            "Docs": "https://github.com/codeinspectorio/citool/",
            "Homepage": "https://github.com/codeinspectorio/citool"
        },
        "release_url": "https://pypi.org/project/code-inspector/0.0.5/",
        "requires_dist": [
            "docopt (>=0.6.1)",
            "requests (>=2.4.2)",
            "urllib3[secure] ; python_version < \"3\"",
            "PyYAML (>=3.10) ; extra == 'yaml'"
        ],
        "requires_python": "",
        "summary": "Trigger new code analysis on code-inspector",
        "version": "0.0.5"
    },
    "last_serial": 5469395,
    "releases": {
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "328f9b9ee0ce406112e8d899a700b5d1",
                    "sha256": "1b9a76f7bb2fa8d861de3451dca4f59294745620642a350bb69c24a577b8deb3"
                },
                "downloads": -1,
                "filename": "code_inspector-0.0.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "328f9b9ee0ce406112e8d899a700b5d1",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 4689,
                "upload_time": "2019-01-12T21:06:34",
                "url": "https://files.pythonhosted.org/packages/a7/c2/5959d5130bf93361dc97e75a46a26d56d82265e6e218f10d7a0be51b903c/code_inspector-0.0.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "235113069cfb5fbd2249951d241a126b",
                    "sha256": "3ba1a55dedc967db6783772544474340d0d09dbd65682f6e6f40c5699fb0bda6"
                },
                "downloads": -1,
                "filename": "code-inspector-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "235113069cfb5fbd2249951d241a126b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3878,
                "upload_time": "2019-01-12T21:06:35",
                "url": "https://files.pythonhosted.org/packages/01/59/16b9bf292d7e5d8ea77d4faf3ff2f23fb2bcde9c8c2a601cc8273efcb445/code-inspector-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a19eec1a31023f1ef9d31ce2fe59aa41",
                    "sha256": "f9541148e2a94294ed7b7723530cb61c66482203c27b9980dc95fc826fdb1a72"
                },
                "downloads": -1,
                "filename": "code_inspector-0.0.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a19eec1a31023f1ef9d31ce2fe59aa41",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 5442,
                "upload_time": "2019-04-26T01:12:51",
                "url": "https://files.pythonhosted.org/packages/76/3f/a742e922d199f7d3d966ac9889931905e4fffbc4ca72324a0af5b748db06/code_inspector-0.0.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "84041324c26b55c131bff9f395f354a7",
                    "sha256": "eebf1b9310772475f268a7e4aae4da2fe9891f530e6bac8fd9bdefab33e45fd8"
                },
                "downloads": -1,
                "filename": "code-inspector-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "84041324c26b55c131bff9f395f354a7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4688,
                "upload_time": "2019-04-26T01:12:53",
                "url": "https://files.pythonhosted.org/packages/9b/e3/bf54e50ea228c86791e92a31c4a974cdf48c7394c586ef063164234c0f0d/code-inspector-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "59b7e5f40c354b14e7dcadbd57f46ac0",
                    "sha256": "aba2fe70e611be316ee2a9c876400ded8ba43892f230ce9161277ffa1697f5b8"
                },
                "downloads": -1,
                "filename": "code_inspector-0.0.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "59b7e5f40c354b14e7dcadbd57f46ac0",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 9410,
                "upload_time": "2019-06-22T02:55:21",
                "url": "https://files.pythonhosted.org/packages/cb/c9/daa0174bb2e4978ba30a248c7c3a9ab3a7448003ca3878bf6efb55916646/code_inspector-0.0.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "73c2a3d2264f8e97bbe7f299250d83e0",
                    "sha256": "9b9ec838399ad7a506fa639ba5ec6a667d6cc72b34b513ba6f91b42405620f0a"
                },
                "downloads": -1,
                "filename": "code-inspector-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "73c2a3d2264f8e97bbe7f299250d83e0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7479,
                "upload_time": "2019-06-22T02:55:23",
                "url": "https://files.pythonhosted.org/packages/cb/b6/986315ccaf12ca0190af544359a39683f3c244781fe2aa8db2fc75986602/code-inspector-0.0.4.tar.gz"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "76ae8499334f4fd336a15af7e24b459c",
                    "sha256": "8b1d8dc1c772a156b90af1ade28e8c560aefde2acc0aff1da24dbecb0d0447cc"
                },
                "downloads": -1,
                "filename": "code_inspector-0.0.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "76ae8499334f4fd336a15af7e24b459c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 11106,
                "upload_time": "2019-07-01T03:02:04",
                "url": "https://files.pythonhosted.org/packages/ab/0a/457bab619f6471f0529729c6b892ca53b4b6c0679bb65bbfe86524e94ee4/code_inspector-0.0.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e9ef0ca76412d33a3aea33e11d122030",
                    "sha256": "80a72546bd6b3f743ff0b6292464e957ad7b6b09dcf30c6449f59dde2f01d31c"
                },
                "downloads": -1,
                "filename": "code-inspector-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "e9ef0ca76412d33a3aea33e11d122030",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9738,
                "upload_time": "2019-07-01T03:02:06",
                "url": "https://files.pythonhosted.org/packages/0d/81/3b1cd3b78c4153efabfb5094678ed7d294b3111381ad04880eddcd538fb8/code-inspector-0.0.5.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "76ae8499334f4fd336a15af7e24b459c",
                "sha256": "8b1d8dc1c772a156b90af1ade28e8c560aefde2acc0aff1da24dbecb0d0447cc"
            },
            "downloads": -1,
            "filename": "code_inspector-0.0.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "76ae8499334f4fd336a15af7e24b459c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 11106,
            "upload_time": "2019-07-01T03:02:04",
            "url": "https://files.pythonhosted.org/packages/ab/0a/457bab619f6471f0529729c6b892ca53b4b6c0679bb65bbfe86524e94ee4/code_inspector-0.0.5-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e9ef0ca76412d33a3aea33e11d122030",
                "sha256": "80a72546bd6b3f743ff0b6292464e957ad7b6b09dcf30c6449f59dde2f01d31c"
            },
            "downloads": -1,
            "filename": "code-inspector-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "e9ef0ca76412d33a3aea33e11d122030",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9738,
            "upload_time": "2019-07-01T03:02:06",
            "url": "https://files.pythonhosted.org/packages/0d/81/3b1cd3b78c4153efabfb5094678ed7d294b3111381ad04880eddcd538fb8/code-inspector-0.0.5.tar.gz"
        }
    ]
}