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. 
 
Links from the show 
 
<div>Ned on Mastodon: <a href="https://hachyderm.io/@nedbat" target="_blank" rel="noopener">@nedbat@hachyderm.io</a> 
Ned's website: <a href="https://nedbatchelder.com" target="_blank" rel="noopener">nedbatchelder.com</a> 
 
Readme as a Service: <a href="https://readme.so" target="_blank" rel="noopener">readme.so</a> 
hatch-fancy-pypi-readme: <a href="https://github.com/hynek/hatch-fancy-pypi-readme" target="_blank" rel="noopener">github.com</a> 
Shields.io badges: <a href="https://shields.io" target="_blank" rel="noopener">shields.io</a> 
All Contributors: <a href="https://allcontributors.org" target="_blank" rel="noopener">allcontributors.org</a> 
Keep a changelog: <a href="https://keepachangelog.com" target="_blank" rel="noopener">keepachangelog.com</a> 
Scriv: Changelog management tool: <a href="https://github.com/nedbat/scriv" target="_blank" rel="noopener">github.com</a> 
changelog_manager: <a href="https://github.com/masukomi/changelog_manager" target="_blank" rel="noopener">github.com</a> 
executablebooks' github activity: <a href="https://github.com/executablebooks/github-activity" target="_blank" rel="noopener">github.com</a> 
dinghy: A GitHub activity digest tool: <a href="https://github.com/nedbat/dinghy" target="_blank" rel="noopener">github.com</a> 
cpython's blurb: <a href="https://github.com/python/core-workflow/tree/master/blurb" target="_blank" rel="noopener">github.com</a> 
release drafter: <a href="https://github.com/release-drafter/release-drafter" target="_blank" rel="noopener">github.com</a> 
Towncrier: <a href="https://github.com/twisted/towncrier" target="_blank" rel="noopener">github.com</a> 
mktestdocs testing code samples in readmes: <a href="https://github.com/koaning/mktestdocs" target="_blank" rel="noopener">github.com</a> 
shed: <a href="https://github.com/Zac-HD/shed" target="_blank" rel="noopener">github.com</a> 
blacken-docs: <a href="https://github.com/adamchainz/blacken-docs" target="_blank" rel="noopener">github.com</a> 
Cog: <a href="https://github.com/nedbat/cog" target="_blank" rel="noopener">github.com</a> 
Awesome tools for readme: <a href="https://github.com/HaiDang666/awesome-tool-for-readme-profile" target="_blank" rel="noopener">github.com</a> 
 
coverage.py: <a href="ttps://coverage.readthedocs.io" target="_blank" rel="noopener">coverage.readthedocs.io</a> 
Tailwind CSS "Landing page": <a href="https://tailwindcss.com" target="_blank" rel="noopener">tailwindcss.com</a> 
Poetry "Landing page": <a href="https://python-poetry.org" target="_blank" rel="noopener">python-poetry.org</a> 
Textual: <a href="https://www.textualize.io" target="_blank" rel="noopener">textualize.io</a> 
Rich: <a href="https://github.com/Textualize/rich" target="_blank" rel="noopener">github.com</a> 
Join Mastodon Page: <a href="https://joinmastodon.org" target="_blank" rel="noopener">joinmastodon.org</a> 
Watch this episode on YouTube: <a href="https://www.youtube.com/watch?v=K7jeBfiNqR4" target="_blank" rel="noopener">youtube.com</a> 
 
--- Stay in touch with us --- 
Subscribe to us on YouTube: <a href="https://talkpython.fm/youtube" target="_blank" rel="noopener">youtube.com</a> 
Follow Talk Python on Mastodon: <a href="https://fosstodon.org/web/@talkpython" target="_blank" rel="noopener">talkpython</a> 
Follow Michael on Mastodon: <a href="https://fosstodon.org/web/@mkennedy" target="_blank" rel="noopener">mkennedy</a> </div> 
Sponsors 
<a href='https://talkpython.fm/max'>Local Maximum Podcast</a>
<a href='https://talkpython.fm/sentry'>Sentry Error Monitoring, Code TALKPYTHON</a>
<a href='https://talkpython.fm/assemblyai'>AssemblyAI</a>
<a href='https://talkpython.fm/training'>Talk Python Training</a>

Podurama

Home

Trending

Personal

Your Podcasts

New Episodes

My Files

Favourite Episodes

Tags (Folders)

Recently Played

Bookmarks

Followed Playlists

#395: Tools for README.md Creation and Maintenance

Talk Python To Me