Metadata-Version: 2.1
Name: bandit-markdown
Version: 0.1.0
Summary: 
Home-page: https://github.com/baniasbaabe/bandit-markdown
License: MIT
Keywords: bandit,markdown,security
Author: baniasbaabe
Author-email: banias@hotmail.de
Requires-Python: >=3.8,<4.0
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: bandit (>=1.7.5,<2.0.0)
Project-URL: Repository, https://github.com/baniasbaabe/bandit-markdown
Description-Content-Type: text/markdown

# bandit-markdown

`bandit-markdown` is a Python Command Line App to apply the security checking tool [bandit](https://github.com/PyCQA/bandit) on Markdown files to avoid showing code samples with vulnerabilities.

## Installation

You can install `bandit-markdown` using pip (note the underscore):

```bash
pip install bandit_markdown
```

## Usage

To use `bandit-markdown`, you just have to specify a glob of Markdown files.

Small example:

```bash
bandit-markdown examples/*.md
```

This will run `bandit` on all the Markdown files in the `examples` directory and print the `bandit` report.

## License

`bandit-markdown` is licensed under the MIT License. See the LICENSE file for more information.

Code is mainly based on [flake8-markdown](https://github.com/johnfraney/flake8-markdown/tree/main)

