# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/baniasbaabe/bandit-markdown",
"name": "bandit-markdown",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "bandit,markdown,security",
"author": "baniasbaabe",
"author_email": "banias@hotmail.de",
"download_url": "https://files.pythonhosted.org/packages/90/7b/baa61b913eec0f3c33962ba8dd4b8fc3d09fa1d51159326ae044242ad173/bandit_markdown-0.1.0.tar.gz",
"platform": null,
"description": "# bandit-markdown\n\n`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.\n\n## Installation\n\nYou can install `bandit-markdown` using pip (note the underscore):\n\n```bash\npip install bandit_markdown\n```\n\n## Usage\n\nTo use `bandit-markdown`, you just have to specify a glob of Markdown files.\n\nSmall example:\n\n```bash\nbandit-markdown examples/*.md\n```\n\nThis will run `bandit` on all the Markdown files in the `examples` directory and print the `bandit` report.\n\n## License\n\n`bandit-markdown` is licensed under the MIT License. See the LICENSE file for more information.\n\nCode is mainly based on [flake8-markdown](https://github.com/johnfraney/flake8-markdown/tree/main)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/baniasbaabe/bandit-markdown",
"Repository": "https://github.com/baniasbaabe/bandit-markdown"
},
"split_keywords": [
"bandit",
"markdown",
"security"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1af070e6cf528adf613ee13689839415a9db4370abc10cfec38640289b86e736",
"md5": "9bb93f9b5091b7207ec837a480207df5",
"sha256": "4b9d52ed48616127fe5edfc0552914f2d1f909313cf29a67cba3b38905691d7e"
},
"downloads": -1,
"filename": "bandit_markdown-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bb93f9b5091b7207ec837a480207df5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3495,
"upload_time": "2023-05-12T14:48:51",
"upload_time_iso_8601": "2023-05-12T14:48:51.498632Z",
"url": "https://files.pythonhosted.org/packages/1a/f0/70e6cf528adf613ee13689839415a9db4370abc10cfec38640289b86e736/bandit_markdown-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "907bbaa61b913eec0f3c33962ba8dd4b8fc3d09fa1d51159326ae044242ad173",
"md5": "804acce4a7d41b73fe6ee223174889f6",
"sha256": "e0be0729392736abd5e27f32a2b159802a017ca76a383795d8602e4850b1f031"
},
"downloads": -1,
"filename": "bandit_markdown-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "804acce4a7d41b73fe6ee223174889f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3237,
"upload_time": "2023-05-12T14:48:53",
"upload_time_iso_8601": "2023-05-12T14:48:53.507787Z",
"url": "https://files.pythonhosted.org/packages/90/7b/baa61b913eec0f3c33962ba8dd4b8fc3d09fa1d51159326ae044242ad173/bandit_markdown-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-12 14:48:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baniasbaabe",
"github_project": "bandit-markdown",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bandit-markdown"
}
JSON
