If you maintain projects on places like GitHub, you know that having a classy readme is important and that maintaining a change log can be helpful for you and consumers of the project. It can also be a pain. That's why I'm excited to welcome back Ned Batchelder to the show. He has a lot of tools to help here as well as some opinions we're looking forward to hearing. We cover his tools and a bunch of others he and I found along the way.<br/>
<br/>
<strong>Links from the show</strong><br/>
<br/>
<div><b>Ned on Mastodon</b>: <a href="https://hachyderm.io/@nedbat" target="_blank" rel="noopener">@nedbat@hachyderm.io</a><br/>
<b>Ned's website</b>: <a href="https://nedbatchelder.com" target="_blank" rel="noopener">nedbatchelder.com</a><br/>
<br/>
<b>Readme as a Service</b>: <a href="https://readme.so" target="_blank" rel="noopener">readme.so</a><br/>
<b>hatch-fancy-pypi-readme</b>: <a href="https://github.com/hynek/hatch-fancy-pypi-readme" target="_blank" rel="noopener">github.com</a><br/>
<b>Shields.io badges</b>: <a href="https://shields.io" target="_blank" rel="noopener">shields.io</a><br/>
<b>All Contributors</b>: <a href="https://allcontributors.org" target="_blank" rel="noopener">allcontributors.org</a><br/>
<b>Keep a changelog</b>: <a href="https://keepachangelog.com" target="_blank" rel="noopener">keepachangelog.com</a><br/>
<b>Scriv: Changelog management tool</b>: <a href="https://github.com/nedbat/scriv" target="_blank" rel="noopener">github.com</a><br/>
<b>changelog_manager</b>: <a href="https://github.com/masukomi/changelog_manager" target="_blank" rel="noopener">github.com</a><br/>
<b>executablebooks' github activity</b>: <a href="https://github.com/executablebooks/github-activity" target="_blank" rel="noopener">github.com</a><br/>
<b>dinghy: A GitHub activity digest tool</b>: <a href="https://github.com/nedbat/dinghy" target="_blank" rel="noopener">github.com</a><br/>
<b>cpython's blurb</b>: <a href="https://github.com/python/core-workflow/tree/master/blurb" target="_blank" rel="noopener">github.com</a><br/>
<b>release drafter</b>: <a href="https://github.com/release-drafter/release-drafter" target="_blank" rel="noopener">github.com</a><br/>
<b>Towncrier</b>: <a href="https://github.com/twisted/towncrier" target="_blank" rel="noopener">github.com</a><br/>
<b>mktestdocs testing code samples in readmes</b>: <a href="https://github.com/koaning/mktestdocs" target="_blank" rel="noopener">github.com</a><br/>
<b>shed</b>: <a href="https://github.com/Zac-HD/shed" target="_blank" rel="noopener">github.com</a><br/>
<b>blacken-docs</b>: <a href="https://github.com/adamchainz/blacken-docs" target="_blank" rel="noopener">github.com</a><br/>
<b>Cog</b>: <a href="https://github.com/nedbat/cog" target="_blank" rel="noopener">github.com</a><br/>
<b>Awesome tools for readme</b>: <a href="https://github.com/HaiDang666/awesome-tool-for-readme-profile" target="_blank" rel="noopener">github.com</a><br/>
<br/>
<b>coverage.py</b>: <a href="ttps://coverage.readthedocs.io" target="_blank" rel="noopener">coverage.readthedocs.io</a><br/>
<b>Tailwind CSS "Landing page"</b>: <a href="https://tailwindcss.com" target="_blank" rel="noopener">tailwindcss.com</a><br/>
<b>Poetry "Landing page"</b>: <a href="https://python-poetry.org" target="_blank" rel="noopener">python-poetry.org</a><br/>
<b>Textual</b>: <a href="https://www.textualize.io" target="_blank" rel="noopener">textualize.io</a><br/>
<b>Rich</b>: <a href="https://github.com/Textualize/rich" target="_blank" rel="noopener">github.com</a><br/>
<b>Join Mastodon Page</b>: <a href="https://joinmastodon.org" target="_blank" rel="noopener">joinmastodon.org</a><br/>
<b>Watch this episode on YouTube</b>: <a href="https://www.youtube.com/watch?v=K7jeBfiNqR4" target="_blank" rel="noopener">youtube.com</a><br/>
<b>Episode transcripts</b>: <a href="https://talkpython.fm/episodes/transcript/395/tools-for-readme.md-creation-and-maintenance" target="_blank" rel="noopener">talkpython.fm</a><br/>
<br/>
<b>--- Stay in touch with us ---</b><br/>
<b>Subscribe to us on YouTube</b>: <a href="https://talkpython.fm/youtube" target="_blank" rel="noopener">youtube.com</a><br/>
<b>Follow Talk Python on Mastodon</b>: <a href="https://fosstodon.org/web/@talkpython" target="_blank" rel="noopener"><i class="fa-brands fa-mastodon"></i>talkpython</a><br/>
<b>Follow Michael on Mastodon</b>: <a href="https://fosstodon.org/web/@mkennedy" target="_blank" rel="noopener"><i class="fa-brands fa-mastodon"></i>mkennedy</a><br/></div><br/>
<strong>Sponsors</strong><br/>
<a href='https://talkpython.fm/max'>Local Maximum Podcast</a><br>
<a href='https://talkpython.fm/sentry'>Sentry Error Monitoring, Code TALKPYTHON</a><br>
<a href='https://talkpython.fm/assemblyai'>AssemblyAI</a><br>
<a href='https://talkpython.fm/training'>Talk Python Training</a>
↧