{"id":13735279,"url":"https://github.com/johnfraney/flake8-markdown","last_synced_at":"2025-04-06T14:11:26.321Z","repository":{"id":51252229,"uuid":"187520825","full_name":"johnfraney/flake8-markdown","owner":"johnfraney","description":"Lints Python code blocks in Markdown files using flake8","archived":false,"fork":false,"pushed_at":"2025-01-09T21:17:59.000Z","size":48,"stargazers_count":24,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T13:10:13.415Z","etag":null,"topics":["flake8","hacktoberfest","linter","markdown","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnfraney.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["johnfraney"],"ko_fi":"johnfraney","tidelift":"pypi/flake8-markdown"}},"created_at":"2019-05-19T19:45:33.000Z","updated_at":"2025-02-22T19:38:22.000Z","dependencies_parsed_at":"2024-06-18T21:30:41.247Z","dependency_job_id":"4d862da5-eee1-4a55-b072-9a222c1287af","html_url":"https://github.com/johnfraney/flake8-markdown","commit_stats":{"total_commits":23,"total_committers":5,"mean_commits":4.6,"dds":"0.30434782608695654","last_synced_commit":"d6f37e1cade4c146dadb2c27ff6ff787065557b4"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfraney%2Fflake8-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfraney%2Fflake8-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfraney%2Fflake8-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfraney%2Fflake8-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnfraney","download_url":"https://codeload.github.com/johnfraney/flake8-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247492515,"owners_count":20947545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flake8","hacktoberfest","linter","markdown","python"],"created_at":"2024-08-03T03:01:04.996Z","updated_at":"2025-04-06T14:11:26.299Z","avatar_url":"https://github.com/johnfraney.png","language":"Python","funding_links":["https://github.com/sponsors/johnfraney","https://ko-fi.com/johnfraney","https://tidelift.com/funding/github/pypi/flake8-markdown"],"categories":["Integrations"],"sub_categories":[],"readme":"# 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[![PyPI downloads per month](https://img.shields.io/pypi/dm/flake8-markdown.svg)](https://pypi.python.org/pypi/flake8-markdown/)\n[![Tox](https://github.com/johnfraney/flake8-markdown/actions/workflows/github-actions-tox.yml/badge.svg)](https://github.com/johnfraney/flake8-markdown/actions/workflows/github-actions-tox.yml)\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```shell\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 \"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.5.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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnfraney%2Fflake8-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnfraney%2Fflake8-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnfraney%2Fflake8-markdown/lists"}