{ "info": { "author": "John Franey", "author_email": "johnfraney@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Framework :: Flake8", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Software Development :: Quality Assurance" ], "description": "# Flake8 Markdown\n\n[\n![PyPI](https://img.shields.io/pypi/v/flake8-markdown.svg)\n![PyPI](https://img.shields.io/pypi/pyversions/flake8-markdown.svg)\n![PyPI](https://img.shields.io/github/license/johnfraney/flake8-markdown.svg)\n](https://pypi.org/project/flake8-markdown/)\n[![TravisCI](https://travis-ci.org/johnfraney/flake8-markdown.svg?branch=master)](https://travis-ci.org/johnfraney/flake8-markdown)\n\nFlake8 Markdown lints [GitHub-style Python code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks#fenced-code-blocks) in Markdown files using [`flake8`](https://flake8.readthedocs.io/en/stable/).\n\nThis package helps improve a Python project's documentation by ensuring that code samples are error-free.\n\n## Features\n\n- Lints code blocks containing regular Python and Python interpreter code ([`pycon`](http://pygments.org/docs/lexers/#pygments.lexers.python.PythonConsoleLexer))\n- [pre-commit](#pre-commit-hook) hook to lint on commit\n\n## Installation\n\nFlake8 Markdown can be installed from PyPI using `pip` or your package manager of choice:\n\n```\npip install flake8-markdown\n```\n\n## Usage\n\n### CLI\n\nYou can use Flake8 Markdown as a CLI tool using the `flake8-markdown` command.\n\n`flake8-markdown` accepts one or more [globs](https://docs.python.org/3.7/library/glob.html) as its arguments.\n\nExample:\n\n```console\n$ flake8-markdown flake8-markdown \"tests/samples/*.md\"\ntests/samples/emphasized_lines.md:6:1: F821 undefined name 'emphasized_imaginary_function'\ntests/samples/basic.md:8:48: E999 SyntaxError: EOL while scanning string literal\ntests/samples/basic.md:14:7: F821 undefined name 'undefined_variable'\n```\n\n### pre-commit hook\n\nYou can also add `flake8-markdown` to your project using [pre-commit](https://pre-commit.com/). When configured, any staged Markdown files will be linted using `flake8-markdown` once you run `git commit`.\n\nTo enable this hook in your local repository, add the following `repo` to your `.pre-commit-config.yaml` file:\n\n```yaml\n# .pre-commit-config.yaml\nrepos:\n - repo: https://github.com/johnfraney/flake8-markdown\n rev: v0.2.0\n hooks:\n - id: flake8-markdown\n```\n\n## Code of Conduct\n\nEveryone interacting in the project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).\n\n## History\n\n## [0.2.0] - 2019-06-14\n\n### Added\n\n- [`pycon`](http://pygments.org/docs/lexers/#pygments.lexers.python.PythonConsoleLexer) code block support\n\n### [0.1.1] - 2019-05-19\n\n#### Changed\n\n- Fixed pre-commit example in README\n\n### [0.1.0] - 2019-05-19\n\n#### Added\n\n- Added code for initial release\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/johnfraney/flake8-markdown", "keywords": "flake8,markdown,lint", "license": "MIT", "maintainer": "John Franey", "maintainer_email": "johnfraney@gmail.com", "name": "flake8-markdown", "package_url": "https://pypi.org/project/flake8-markdown/", "platform": "", "project_url": "https://pypi.org/project/flake8-markdown/", "project_urls": { "Homepage": "https://github.com/johnfraney/flake8-markdown", "Repository": "https://github.com/johnfraney/flake8-markdown" }, "release_url": "https://pypi.org/project/flake8-markdown/0.2.0/", "requires_dist": [ "flake8 (>=3.7,<4.0)" ], "requires_python": ">=3.6,<4.0", "summary": "Lints Python code blocks in Markdown files using flake8", "version": "0.2.0" }, "last_serial": 5402848, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1a0d357f6a249c9d7c050fba09c084e3", "sha256": "e4cc757dd779f61ca8d057b5bd429a7ead79d2d0adee2f0e232539e721bb6990" }, "downloads": -1, "filename": "flake8_markdown-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1a0d357f6a249c9d7c050fba09c084e3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 5053, "upload_time": "2019-05-19T20:50:37", "url": "https://files.pythonhosted.org/packages/12/db/4912b0fb7431e20518ae70b0937116386f78957a4cca0f5c200739b46f3c/flake8_markdown-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4f320e8cc041c7e097988d9a1ba35ae5", "sha256": "e5b6e61d051e54d036d653e0aadaaa89e0051f6fdfea4f357ea0249d231a9bbf" }, "downloads": -1, "filename": "flake8-markdown-0.1.0.tar.gz", "has_sig": false, "md5_digest": "4f320e8cc041c7e097988d9a1ba35ae5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 4431, "upload_time": "2019-05-19T20:50:39", "url": "https://files.pythonhosted.org/packages/3f/5e/a1070c8303e739456041617773666922953ad5b33224aeb012aece747df1/flake8-markdown-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "2e66a6bcf5fc78c11afcbbf8434fff86", "sha256": "1b07d23352bd674ec302ff14dc5a3891c59b7208e5b72baf5ee79bc9f3345064" }, "downloads": -1, "filename": "flake8_markdown-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2e66a6bcf5fc78c11afcbbf8434fff86", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 5088, "upload_time": "2019-05-19T21:09:11", "url": "https://files.pythonhosted.org/packages/30/b6/62ceacb4be4c6e1c05fe52797ff1aca2c76f641119eeb027ec47c1d59916/flake8_markdown-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e9352ed90dc5ba30599cfacc55563dd", "sha256": "7d2478cce444eda70e2250872a5f475ce94ef965295873f2916f3f3fed0a8ff5" }, "downloads": -1, "filename": "flake8-markdown-0.1.1.tar.gz", "has_sig": false, "md5_digest": "3e9352ed90dc5ba30599cfacc55563dd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 4502, "upload_time": "2019-05-19T21:09:13", "url": "https://files.pythonhosted.org/packages/33/5b/e4e54d09adb5e1be0ded1a32e7f10580526624948306b752faa183c35cd5/flake8-markdown-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "392717a0874c3c72c5ce62fe67029d46", "sha256": "6727f28c71b941f0026bc7e08675a71002bfbf69018317bcec81e0502a33db3f" }, "downloads": -1, "filename": "flake8_markdown-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "392717a0874c3c72c5ce62fe67029d46", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 6298, "upload_time": "2019-06-15T03:30:36", "url": "https://files.pythonhosted.org/packages/2a/ce/12f490a3d16fe4b572ea1a2a50ac8edee052ab03b2a524929f023f789592/flake8_markdown-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "54bca03d4bb1ffb0d0419475fca77fbd", "sha256": "bca29422c66815c2f360fea3efce7356d42832e925d8ceb0525983f4e94a591c" }, "downloads": -1, "filename": "flake8-markdown-0.2.0.tar.gz", "has_sig": false, "md5_digest": "54bca03d4bb1ffb0d0419475fca77fbd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 5060, "upload_time": "2019-06-15T03:30:34", "url": "https://files.pythonhosted.org/packages/f3/ef/47b6ca735f86e9160a92b53c66845e207c84a010e1af797dedcefe9027d3/flake8-markdown-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "392717a0874c3c72c5ce62fe67029d46", "sha256": "6727f28c71b941f0026bc7e08675a71002bfbf69018317bcec81e0502a33db3f" }, "downloads": -1, "filename": "flake8_markdown-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "392717a0874c3c72c5ce62fe67029d46", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 6298, "upload_time": "2019-06-15T03:30:36", "url": "https://files.pythonhosted.org/packages/2a/ce/12f490a3d16fe4b572ea1a2a50ac8edee052ab03b2a524929f023f789592/flake8_markdown-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "54bca03d4bb1ffb0d0419475fca77fbd", "sha256": "bca29422c66815c2f360fea3efce7356d42832e925d8ceb0525983f4e94a591c" }, "downloads": -1, "filename": "flake8-markdown-0.2.0.tar.gz", "has_sig": false, "md5_digest": "54bca03d4bb1ffb0d0419475fca77fbd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 5060, "upload_time": "2019-06-15T03:30:34", "url": "https://files.pythonhosted.org/packages/f3/ef/47b6ca735f86e9160a92b53c66845e207c84a010e1af797dedcefe9027d3/flake8-markdown-0.2.0.tar.gz" } ] }