#426 Committing to Formatted Markdown

Topics covered in this episode:

• mdformat
• pre-commit-uv
• PEP 758 and 781
• Serie: rich git commit graph in your terminal, like magic
• Extras
• Joke

Watch on YouTube

About the show

Sponsored by Posit Connect Cloud: pythonbytes.fm/connect-cloud

Connect with the hosts

• Michael: @[e-mail] / @mkennedy.codes (bsky)
• Brian: @[e-mail] / @brianokken.bsky.social
• Show: @[e-mail] / @pythonbytes.fm (bsky)

Join us on YouTube at pythonbytes.fm/live to be part of the audience. Usually Monday at 10am PT. Older video versions available there too.

Finally, if you want an artisanal, hand-crafted digest of every week of the show notes in email form? Add your name and email to our friends of the show list, we'll never share it.

Brian #1: mdformat

• Suggested by Matthias Schöttle
• Last episode Michael covered blacken-docs, and I mentioned it’d be nice to have an autoformatter for text markdown.
• Matthias delivered with suggesting mdformat
• “Mdformat is an opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files.”
• A python project that can be run on the command line.
• Uses a style guide I mostly agree with.
  • I’m not a huge fan of numbered list items all being “1.”, but that can be turned off with --number, so I’m happy.
  • Converts underlined headings to #, ##, etc. headings.
  • Lots of other sane conventions.
  • The numbering thing is also sane, I just think it also makes the raw markdown hard to read.
• Has a plugin system to format code blocks

Michael #2: pre-commit-uv

• via Ben Falk
• Use uv to create virtual environments and install packages for pre-commit.

Brian #3: PEP 758 and 781

• PEP 758 – Allow except and except*