bandit


Namebandit JSON
Version 1.7.10 PyPI version JSON
download
home_pagehttps://bandit.readthedocs.io/
SummarySecurity oriented static analyser for python code.
upload_time2024-09-23 17:33:34
maintainerNone
docs_urlNone
authorPyCQA
requires_python>=3.8
licenseApache-2.0 license
keywords
VCS
bugtrack_url
requirements PyYAML stevedore colorama rich
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png
    :alt: Bandit

======

.. image:: https://github.com/PyCQA/bandit/actions/workflows/pythonpackage.yml/badge.svg?branch=main
    :target: https://github.com/PyCQA/bandit/actions?query=workflow%3A%22Build+and+Test+Bandit%22+branch%3Amain
    :alt: Build Status

.. image:: https://readthedocs.org/projects/bandit/badge/?version=latest
    :target: https://readthedocs.org/projects/bandit/
    :alt: Docs Status

.. image:: https://img.shields.io/pypi/v/bandit.svg
    :target: https://pypi.org/project/bandit/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/bandit.svg
    :target: https://pypi.org/project/bandit/
    :alt: Python Versions

.. image:: https://img.shields.io/pypi/format/bandit.svg
    :target: https://pypi.org/project/bandit/
    :alt: Format

.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
    :target: https://github.com/PyCQA/bandit/blob/main/LICENSE
    :alt: License

.. image:: https://img.shields.io/discord/825463413634891776.svg
    :target: https://discord.gg/qYxpadCgkx
    :alt: Discord

A security linter from PyCQA

* Free software: Apache license
* Documentation: https://bandit.readthedocs.io/en/latest/
* Source: https://github.com/PyCQA/bandit
* Bugs: https://github.com/PyCQA/bandit/issues
* Contributing: https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md

Overview
--------

Bandit is a tool designed to find common security issues in Python code. To do
this Bandit processes each file, builds an AST from it, and runs appropriate
plugins against the AST nodes. Once Bandit has finished scanning all the files
it generates a report.

Bandit was originally developed within the OpenStack Security Project and
later rehomed to PyCQA.

.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/bandit-terminal.png
    :alt: Bandit Example Screen Shot

Show Your Style
---------------

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security Status

Use our badge in your project's README!

using Markdown::

    [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

using RST::

    .. image:: https://img.shields.io/badge/security-bandit-yellow.svg
        :target: https://github.com/PyCQA/bandit
        :alt: Security Status

References
----------

Python AST module documentation: https://docs.python.org/3/library/ast.html

Green Tree Snakes - the missing Python AST docs:
https://greentreesnakes.readthedocs.org/en/latest/

Documentation of the various types of AST nodes that Bandit currently covers
or could be extended to cover:
https://greentreesnakes.readthedocs.org/en/latest/nodes.html

Container Images
----------------

Bandit is available as a container image, built within the bandit repository
using GitHub Actions. The image is available on ghcr.io:

.. code-block:: console

    docker pull ghcr.io/pycqa/bandit/bandit

The image is built for the following architectures:

* amd64
* arm64
* armv7
* armv8

To pull a specific architecture, use the following format:

.. code-block:: console

    docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest

Every image is signed with sigstore cosign and it is possible to verify the
source of origin using the following cosign command:

.. code-block:: console

    cosign verify ghcr.io/pycqa/bandit/bandit:latest \
      --certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \
      --certificate-oidc-issuer https://token.actions.githubusercontent.com

Where `<version>` is the release version of Bandit.

Sponsors
--------

The development of Bandit is made possible by the following sponsors:

.. list-table::
   :width: 100%
   :class: borderless

   * - .. image:: https://github.githubassets.com/assets/tidelift-8cea37dea8fc.svg
          :target: https://tidelift.com/lifter/search/pypi/bandit
          :alt: Tidelift
          :width: 88

     - .. image:: https://avatars.githubusercontent.com/u/110237746?s=200&v=4
          :target: https://stacklok.com/
          :alt: Stacklok
          :width: 88

     - .. image:: https://avatars.githubusercontent.com/u/1396951?s=70&v=4
          :target: https://sentry.io/
          :alt: Sentry
          :width: 88

If you also ❤️ Bandit, please consider sponsoring.




            

Raw data

            {
    "_id": null,
    "home_page": "https://bandit.readthedocs.io/",
    "name": "bandit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "PyCQA",
    "author_email": "code-quality@python.org",
    "download_url": "https://files.pythonhosted.org/packages/38/26/bdd962d6ee781f6229c3fb83483cf9e09d87959150a9000789806d750f3c/bandit-1.7.10.tar.gz",
    "platform": null,
    "description": ".. image:: https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png\n    :alt: Bandit\n\n======\n\n.. image:: https://github.com/PyCQA/bandit/actions/workflows/pythonpackage.yml/badge.svg?branch=main\n    :target: https://github.com/PyCQA/bandit/actions?query=workflow%3A%22Build+and+Test+Bandit%22+branch%3Amain\n    :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/bandit/badge/?version=latest\n    :target: https://readthedocs.org/projects/bandit/\n    :alt: Docs Status\n\n.. image:: https://img.shields.io/pypi/v/bandit.svg\n    :target: https://pypi.org/project/bandit/\n    :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/pyversions/bandit.svg\n    :target: https://pypi.org/project/bandit/\n    :alt: Python Versions\n\n.. image:: https://img.shields.io/pypi/format/bandit.svg\n    :target: https://pypi.org/project/bandit/\n    :alt: Format\n\n.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg\n    :target: https://github.com/PyCQA/bandit/blob/main/LICENSE\n    :alt: License\n\n.. image:: https://img.shields.io/discord/825463413634891776.svg\n    :target: https://discord.gg/qYxpadCgkx\n    :alt: Discord\n\nA security linter from PyCQA\n\n* Free software: Apache license\n* Documentation: https://bandit.readthedocs.io/en/latest/\n* Source: https://github.com/PyCQA/bandit\n* Bugs: https://github.com/PyCQA/bandit/issues\n* Contributing: https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md\n\nOverview\n--------\n\nBandit is a tool designed to find common security issues in Python code. To do\nthis Bandit processes each file, builds an AST from it, and runs appropriate\nplugins against the AST nodes. Once Bandit has finished scanning all the files\nit generates a report.\n\nBandit was originally developed within the OpenStack Security Project and\nlater rehomed to PyCQA.\n\n.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/bandit-terminal.png\n    :alt: Bandit Example Screen Shot\n\nShow Your Style\n---------------\n\n.. image:: https://img.shields.io/badge/security-bandit-yellow.svg\n    :target: https://github.com/PyCQA/bandit\n    :alt: Security Status\n\nUse our badge in your project's README!\n\nusing Markdown::\n\n    [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n\nusing RST::\n\n    .. image:: https://img.shields.io/badge/security-bandit-yellow.svg\n        :target: https://github.com/PyCQA/bandit\n        :alt: Security Status\n\nReferences\n----------\n\nPython AST module documentation: https://docs.python.org/3/library/ast.html\n\nGreen Tree Snakes - the missing Python AST docs:\nhttps://greentreesnakes.readthedocs.org/en/latest/\n\nDocumentation of the various types of AST nodes that Bandit currently covers\nor could be extended to cover:\nhttps://greentreesnakes.readthedocs.org/en/latest/nodes.html\n\nContainer Images\n----------------\n\nBandit is available as a container image, built within the bandit repository\nusing GitHub Actions. The image is available on ghcr.io:\n\n.. code-block:: console\n\n    docker pull ghcr.io/pycqa/bandit/bandit\n\nThe image is built for the following architectures:\n\n* amd64\n* arm64\n* armv7\n* armv8\n\nTo pull a specific architecture, use the following format:\n\n.. code-block:: console\n\n    docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest\n\nEvery image is signed with sigstore cosign and it is possible to verify the\nsource of origin using the following cosign command:\n\n.. code-block:: console\n\n    cosign verify ghcr.io/pycqa/bandit/bandit:latest \\\n      --certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \\\n      --certificate-oidc-issuer https://token.actions.githubusercontent.com\n\nWhere `<version>` is the release version of Bandit.\n\nSponsors\n--------\n\nThe development of Bandit is made possible by the following sponsors:\n\n.. list-table::\n   :width: 100%\n   :class: borderless\n\n   * - .. image:: https://github.githubassets.com/assets/tidelift-8cea37dea8fc.svg\n          :target: https://tidelift.com/lifter/search/pypi/bandit\n          :alt: Tidelift\n          :width: 88\n\n     - .. image:: https://avatars.githubusercontent.com/u/110237746?s=200&v=4\n          :target: https://stacklok.com/\n          :alt: Stacklok\n          :width: 88\n\n     - .. image:: https://avatars.githubusercontent.com/u/1396951?s=70&v=4\n          :target: https://sentry.io/\n          :alt: Sentry\n          :width: 88\n\nIf you also \u2764\ufe0f Bandit, please consider sponsoring.\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0 license",
    "summary": "Security oriented static analyser for python code.",
    "version": "1.7.10",
    "project_urls": {
        "Homepage": "https://bandit.readthedocs.io/",
        "Issue Tracker": "https://github.com/PyCQA/bandit/issues",
        "Release Notes": "https://github.com/PyCQA/bandit/releases",
        "Source Code": "https://github.com/PyCQA/bandit"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e9c491231d973d54f6465002812b4cadc663f208436407745be473254725f55",
                "md5": "ff168db1e65549e14ada79ee73492682",
                "sha256": "665721d7bebbb4485a339c55161ac0eedde27d51e638000d91c8c2d68343ad02"
            },
            "downloads": -1,
            "filename": "bandit-1.7.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ff168db1e65549e14ada79ee73492682",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 130756,
            "upload_time": "2024-09-23T17:33:32",
            "upload_time_iso_8601": "2024-09-23T17:33:32.428475Z",
            "url": "https://files.pythonhosted.org/packages/9e/9c/491231d973d54f6465002812b4cadc663f208436407745be473254725f55/bandit-1.7.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3826bdd962d6ee781f6229c3fb83483cf9e09d87959150a9000789806d750f3c",
                "md5": "fcdc31c49375f6d431887a16dee54a51",
                "sha256": "59ed5caf5d92b6ada4bf65bc6437feea4a9da1093384445fed4d472acc6cff7b"
            },
            "downloads": -1,
            "filename": "bandit-1.7.10.tar.gz",
            "has_sig": false,
            "md5_digest": "fcdc31c49375f6d431887a16dee54a51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4228540,
            "upload_time": "2024-09-23T17:33:34",
            "upload_time_iso_8601": "2024-09-23T17:33:34.099197Z",
            "url": "https://files.pythonhosted.org/packages/38/26/bdd962d6ee781f6229c3fb83483cf9e09d87959150a9000789806d750f3c/bandit-1.7.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-23 17:33:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PyCQA",
    "github_project": "bandit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "PyYAML",
            "specs": [
                [
                    ">=",
                    "5.3.1"
                ]
            ]
        },
        {
            "name": "stevedore",
            "specs": [
                [
                    ">=",
                    "1.20.0"
                ]
            ]
        },
        {
            "name": "colorama",
            "specs": [
                [
                    ">=",
                    "0.3.9"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "bandit"
}
        
Elapsed time: 0.38237s