{ "info": { "author": "Guillaume Papin", "author_email": "guillaume.papin@epitech.eu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Software Development :: Build Tools" ], "description": "compdb: the compilation database Swiss army knife\n=================================================\n\n.. contents:: :local:\n\n\nIntroduction\n------------\n\ncompdb_ is a command line tool to manipulates compilation databases.\nA compilation database is a database for compile options,\nit has records of which compile options are used to build the files in a project.\nAn example of compilation database is the `JSON Compilation Database`_\n\n``compdb`` aims to make it easier for you to run tools on your codebase\nby spoon-feeding you the right compile options.\n\n``compdb`` is not so much about generating the initial compilation database,\nthis, is left to other tools, such as ``cmake`` and ``ninja``.\nIt is only a glue between the initial compilation database and your tool(s).\n\n\nMotivation\n----------\n\nWith the proliferation of Clang-based tools,\nit has become apparent that the compile options\nare no longer useful uniquely to the compiler.\n\nStandalone tools such as clang-tidy_\nor text editors with libclang_ integration have to deal with compile options.\n\nExamples of such tools, dealing with compilation databases are:\nirony-mode_, rtags_ and ycmd_.\n\nBased on this evidence, ``compdb`` came to life.\nA tool that has knowledge of the compile options and can share it\nboth to inform the text editor and to run clang based tool from the shell.\n\n\nGetting started\n---------------\n\nInstallation\n~~~~~~~~~~~~\n\nInstall with pip_::\n\n pip install compdb\n\nFrom Github, as user::\n\n pip install --user git+https://github.com/Sarcasm/compdb.git#egg=compdb\n\n\nGenerate a compilation database with header files\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAssuming a build directory ``build/``, containing a ``compile_commands.json``,\na new compilation database, containing the header files,\ncan be generated with::\n\n compdb -p build/ list > compile_commands.json\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nTo run the tests, type::\n\n python -m tests\n\nOr::\n\n tox --skip-missing-interpreters\n\nFor regression tests on a few open source projects::\n\n cd tests/regression/headerdb\n make [all|help]\n\n\nContribute\n----------\n\nContributions are always welcome!\n\nTry to be consistent with the actual code, it will ease the review.\n\n\nLicense\n-------\n\nThis project is licensed under the MIT License.\nSee LICENSE.txt for details.\n\n\nAcknowledgments\n---------------\n\n* repo_: for its ubiquitous command line interface,\n which served as an inspiration\n* scan-build_: for the clear Python package design\n* git_: for the ``git-config`` API\n* `julio.meroh.net`_: for the interesting article serie on `CLI design`_\n\n\n.. _clang-tidy: http://clang.llvm.org/extra/clang-tidy/\n.. _CLI design: https://julio.meroh.net/2013/09/cli-design-series-wrap-up.html\n.. _compdb: https://github.com/Sarcasm/compdb\n.. _git: https://git-scm.com/\n.. _irony-mode: https://github.com/Sarcasm/irony-mode\n.. _julio.meroh.net: https://julio.meroh.net/\n.. _JSON Compilation Database: http://clang.llvm.org/docs/JSONCompilationDatabase.html\n.. _libclang: http://clang.llvm.org/doxygen/group__CINDEX.html\n.. _pip: https://pip.pypa.io/\n.. _repo: https://gerrit.googlesource.com/git-repo/\n.. _rtags: https://github.com/Andersbakken/rtags\n.. _scan-build: https://github.com/rizsotto/scan-build\n.. _ycmd: https://github.com/Valloric/ycmd\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/Sarcasm/compdb", "keywords": "Clang,compilation-database,compdb", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "compdb", "package_url": "https://pypi.org/project/compdb/", "platform": "", "project_url": "https://pypi.org/project/compdb/", "project_urls": { "Homepage": "https://github.com/Sarcasm/compdb" }, "release_url": "https://pypi.org/project/compdb/0.2.0/", "requires_dist": [ "configparser; python_version<'3.0'" ], "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "summary": "The compilation database Swiss army knife", "version": "0.2.0" }, "last_serial": 3707941, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "d41a15665988e1a024a19bcf7fa8e0a4", "sha256": "a7cbac5c0ffbee8e07ecdc0837677e527a2dba2a24559b4ddafdfd767ec99ba9" }, "downloads": -1, "filename": "compdb-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d41a15665988e1a024a19bcf7fa8e0a4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12024, "upload_time": "2016-11-18T02:48:28", "url": "https://files.pythonhosted.org/packages/ba/73/b479bae81ea941c59d68b1bb9cd9d97a8c103dea8f90ebd06cd0e13c2ffd/compdb-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "74238ccd2e536c64b671bdc732d31e05", "sha256": "2100e6f0d5bf37e4ca47e169182531762357010ef3184efb298d0f912c83449a" }, "downloads": -1, "filename": "compdb-0.0.1.tar.gz", "has_sig": false, "md5_digest": "74238ccd2e536c64b671bdc732d31e05", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10021, "upload_time": "2016-11-18T02:48:31", "url": "https://files.pythonhosted.org/packages/4b/99/9be198414a0c8794efc26bffd226fbbf8ed4e41b39b82372dc971452ae20/compdb-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "a952d19aa4a1b29b6e22c91fcd36ebe1", "sha256": "10729518683f4799697152824fe08b864b8e00256a12ed3d66f616a9cec899cf" }, "downloads": -1, "filename": "compdb-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a952d19aa4a1b29b6e22c91fcd36ebe1", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 25047, "upload_time": "2017-03-14T23:35:02", "url": "https://files.pythonhosted.org/packages/5b/ab/d117cfede7c6e43a99d40d91d408553c3e8877c637e845e4a92f59177a9c/compdb-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c6c22bd5e77390315bad060962dc1b60", "sha256": "238c3bdcb42a343b16ebd4dde6503ff771a013471a779dd776fbc5d6b69f991b" }, "downloads": -1, "filename": "compdb-0.0.2.tar.gz", "has_sig": false, "md5_digest": "c6c22bd5e77390315bad060962dc1b60", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 20143, "upload_time": "2017-03-14T23:35:04", "url": "https://files.pythonhosted.org/packages/4f/b6/01a0971e5be2943fc354f74e23e645a75aeaf86e7d0b05e7e17be5a9e2c5/compdb-0.0.2.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "ab6f8b7890936f22c15cca31743d1676", "sha256": "678459d48f0fb3c6d0eb743380068f0bade2ac8dbc1fd14d25412f27d9d3c79d" }, "downloads": -1, "filename": "compdb-0.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "ab6f8b7890936f22c15cca31743d1676", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 25252, "upload_time": "2017-04-04T22:45:32", "url": "https://files.pythonhosted.org/packages/48/83/0c478606eb78e28318b48ed3e8a8d5c1c546cb58d85b9936bc90ea40b548/compdb-0.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5e245fdf5e89950401600a3ed7416e5c", "sha256": "fec6820b39164f5d41407d7b9948cd17683ff88f94345450b38fdc1db913cc61" }, "downloads": -1, "filename": "compdb-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5e245fdf5e89950401600a3ed7416e5c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 25213, "upload_time": "2017-04-04T22:45:33", "url": "https://files.pythonhosted.org/packages/cc/c8/62a55ccfe8d60ed39a61fa636b13c847a230bde2734699480e8114d66906/compdb-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5b9fe17c65378b93ce30a07e83778a29", "sha256": "d1273a6a7a0b79c9efdea2e75a96df5abb33674514cd5dcd1bc0c2678147c670" }, "downloads": -1, "filename": "compdb-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5b9fe17c65378b93ce30a07e83778a29", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 20271, "upload_time": "2017-04-04T22:45:35", "url": "https://files.pythonhosted.org/packages/7e/36/b84f2c4fb466eb62eb3dab7d3982972523913c4ca082a2854760f679f914/compdb-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "8199888497844dbcfcdcd41585b97928", "sha256": "f25378f6569cc5f5523671b8d9563671005d81d34c6641825f9f6d78bc7c84a0" }, "downloads": -1, "filename": "compdb-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8199888497844dbcfcdcd41585b97928", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 25289, "upload_time": "2017-05-02T22:51:58", "url": "https://files.pythonhosted.org/packages/55/4b/5698cc5a61d9da88357ebd0690812159ec61202d6037faf8cb42251c6bfa/compdb-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c98a1f25bd906cbf6a125cbaa62dea65", "sha256": "03c8e1dc0c3eacea5bb81eb1688fc44e0d216d09919099dd383c901d7c1f068d" }, "downloads": -1, "filename": "compdb-0.1.1.tar.gz", "has_sig": false, "md5_digest": "c98a1f25bd906cbf6a125cbaa62dea65", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 22833, "upload_time": "2017-05-02T22:52:00", "url": "https://files.pythonhosted.org/packages/aa/59/9301a77a1dd7eb3da9744daa756e437b8cd82f7f71a196d66df5aa8f5926/compdb-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "aaf24ee0d877a5e7a67919d785a54e2d", "sha256": "f63b87d36a50b984a654dea1c782066cf659cad66d9b37e2d06cede7d0737b91" }, "downloads": -1, "filename": "compdb-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "aaf24ee0d877a5e7a67919d785a54e2d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 26333, "upload_time": "2018-03-26T20:10:06", "url": "https://files.pythonhosted.org/packages/19/60/009b092d1664e20c8726dbead6aa0093747fca23ae85b7d7a5fc3c4c22e0/compdb-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "28793b9df90a12c92bfc13e246824b71", "sha256": "73471badd01e5e69c816fb3a4e0d014f099c2826ee283df5716cd7b1902b79dd" }, "downloads": -1, "filename": "compdb-0.2.0.tar.gz", "has_sig": false, "md5_digest": "28793b9df90a12c92bfc13e246824b71", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 21128, "upload_time": "2018-03-26T20:10:07", "url": "https://files.pythonhosted.org/packages/7a/14/979e6c597d5e5c106462f98c6373e7684f5a771a73e10cef59eb9fce3f93/compdb-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aaf24ee0d877a5e7a67919d785a54e2d", "sha256": "f63b87d36a50b984a654dea1c782066cf659cad66d9b37e2d06cede7d0737b91" }, "downloads": -1, "filename": "compdb-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "aaf24ee0d877a5e7a67919d785a54e2d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 26333, "upload_time": "2018-03-26T20:10:06", "url": "https://files.pythonhosted.org/packages/19/60/009b092d1664e20c8726dbead6aa0093747fca23ae85b7d7a5fc3c4c22e0/compdb-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "28793b9df90a12c92bfc13e246824b71", "sha256": "73471badd01e5e69c816fb3a4e0d014f099c2826ee283df5716cd7b1902b79dd" }, "downloads": -1, "filename": "compdb-0.2.0.tar.gz", "has_sig": false, "md5_digest": "28793b9df90a12c92bfc13e246824b71", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", "size": 21128, "upload_time": "2018-03-26T20:10:07", "url": "https://files.pythonhosted.org/packages/7a/14/979e6c597d5e5c106462f98c6373e7684f5a771a73e10cef59eb9fce3f93/compdb-0.2.0.tar.gz" } ] }