cpplint


Namecpplint JSON
Version 1.6.1 PyPI version JSON
download
home_pagehttps://github.com/cpplint/cpplint
SummaryAutomated checker to ensure C++ files follow Google's style guide
upload_time2022-08-20 14:18:12
maintainercpplint Developers
docs_urlNone
author
requires_python
licenseBSD-3-Clause
keywords lint python c++
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            cpplint - static code checker for C++
=====================================

.. image:: https://img.shields.io/pypi/v/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/pyversions/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/status/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/l/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/dd/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/dw/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

.. image:: https://img.shields.io/pypi/dm/cpplint.svg
    :target: https://pypi.python.org/pypi/cpplint

Cpplint is a command-line tool to check C/C++ files for style issues following `Google's C++ style guide <http://google.github.io/styleguide/cppguide.html>`_.
Cpplint is developed and maintained by Google Inc. at `google/styleguide <https://github.com/google/styleguide>`_, also see the `wikipedia entry <http://en.wikipedia.org/wiki/Cpplint>`_

While Google maintains cpplint, Google is not (very) responsive to issues and pull requests, this fork aims to be (somewhat) more open to add fixes to cpplint to enable fixes, when those fixes make cpplint usable in wider contexts.
Also see discussion here https://github.com/google/styleguide/pull/528.


Installation
============


To install cpplint from PyPI, run:

.. code-block:: bash

    $ pip install cpplint

Then run it with:

.. code-block:: bash

    $ cpplint [OPTIONS] files

For full usage instructions, run:

.. code-block:: bash

    $ cpplint --help

Changes
-------

The modifications in this fork are minor fixes and cosmetic changes, such as:

* python 3 compatibility
* more default file extensions
* customizable file extensions with the --extensions argument
* continuous integration on github
* support for recursive file discovery via the --recursive argument
* support for excluding files via --exclude
* JUnit XML output format
* Overriding repository root auto-detection via --repository
* Support ``#pragma once`` as an alternative to header include guards
* ... and a few more (most of which are open PRs on upstream)


Acknowledgements
----------------

Thanks to Google Inc. for open-sourcing their in-house tool.
Thanks to maintainers of the fork

* `tkruse <https://github.com/tkruse>`_  
* `mattyclarkson <https://github.com/mattyclarkson>`_
* `theandrewdavis <https://github.com/theandrewdavis>`_

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cpplint/cpplint",
    "name": "cpplint",
    "maintainer": "cpplint Developers",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "see_github@nospam.com",
    "keywords": "lint,python,c++",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/18/72/ea0f4035bcf35d8f8df053657d7f3370d56ff4d4e6617021b6544b9958d4/cpplint-1.6.1.tar.gz",
    "platform": null,
    "description": "cpplint - static code checker for C++\n=====================================\n\n.. image:: https://img.shields.io/pypi/v/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/pyversions/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/status/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/l/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/dd/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/dw/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\n.. image:: https://img.shields.io/pypi/dm/cpplint.svg\n    :target: https://pypi.python.org/pypi/cpplint\n\nCpplint is a command-line tool to check C/C++ files for style issues following `Google's C++ style guide <http://google.github.io/styleguide/cppguide.html>`_.\nCpplint is developed and maintained by Google Inc. at `google/styleguide <https://github.com/google/styleguide>`_, also see the `wikipedia entry <http://en.wikipedia.org/wiki/Cpplint>`_\n\nWhile Google maintains cpplint, Google is not (very) responsive to issues and pull requests, this fork aims to be (somewhat) more open to add fixes to cpplint to enable fixes, when those fixes make cpplint usable in wider contexts.\nAlso see discussion here https://github.com/google/styleguide/pull/528.\n\n\nInstallation\n============\n\n\nTo install cpplint from PyPI, run:\n\n.. code-block:: bash\n\n    $ pip install cpplint\n\nThen run it with:\n\n.. code-block:: bash\n\n    $ cpplint [OPTIONS] files\n\nFor full usage instructions, run:\n\n.. code-block:: bash\n\n    $ cpplint --help\n\nChanges\n-------\n\nThe modifications in this fork are minor fixes and cosmetic changes, such as:\n\n* python 3 compatibility\n* more default file extensions\n* customizable file extensions with the --extensions argument\n* continuous integration on github\n* support for recursive file discovery via the --recursive argument\n* support for excluding files via --exclude\n* JUnit XML output format\n* Overriding repository root auto-detection via --repository\n* Support ``#pragma once`` as an alternative to header include guards\n* ... and a few more (most of which are open PRs on upstream)\n\n\nAcknowledgements\n----------------\n\nThanks to Google Inc. for open-sourcing their in-house tool.\nThanks to maintainers of the fork\n\n* `tkruse <https://github.com/tkruse>`_  \n* `mattyclarkson <https://github.com/mattyclarkson>`_\n* `theandrewdavis <https://github.com/theandrewdavis>`_\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Automated checker to ensure C++ files follow Google's style guide",
    "version": "1.6.1",
    "split_keywords": [
        "lint",
        "python",
        "c++"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1adcc95b6bfef59b3117b05bf3dc112e",
                "sha256": "00ddc86d6e4de2a9dcfa272402dcbe21593363a93b7c475bc391e335062f34b1"
            },
            "downloads": -1,
            "filename": "cpplint-1.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1adcc95b6bfef59b3117b05bf3dc112e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 77257,
            "upload_time": "2022-08-20T14:18:05",
            "upload_time_iso_8601": "2022-08-20T14:18:05.885062Z",
            "url": "https://files.pythonhosted.org/packages/6c/68/31f71f3946e1b445cc5ffa2bc7143488b1f3a556dce344c5b6ae498bbe2a/cpplint-1.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a3e842f20d6cf6f512e7885f71937bdb",
                "sha256": "d430ce8f67afc1839340e60daa89e90de08b874bc27149833077bba726dfc13a"
            },
            "downloads": -1,
            "filename": "cpplint-1.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a3e842f20d6cf6f512e7885f71937bdb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 364487,
            "upload_time": "2022-08-20T14:18:12",
            "upload_time_iso_8601": "2022-08-20T14:18:12.999416Z",
            "url": "https://files.pythonhosted.org/packages/18/72/ea0f4035bcf35d8f8df053657d7f3370d56ff4d4e6617021b6544b9958d4/cpplint-1.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-08-20 14:18:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "cpplint",
    "github_project": "cpplint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "cpplint"
}
        
Elapsed time: 0.01811s