README.md

(Professionally) Coding with Others

Here's a bunch of resources referenced in my PyCon US 2022 talk!

Documentation

• WriteTheDocs
• Choose a License
• Building Docs Like Code, by Mason Egger, PyCon US 2020 (youtube)
• Static Sites with Sphinx and Markdown, by Paul Everitt, PyCon US 2021 (youtube)
• Sphinx
• MkDocs
• Write Docs Devs Love, by Mason Egger, PyCon US 2022 (youtube)

Version Control

• Atlassian Git Tutorial
• Oh Shit, Git?!?
• Dangit, Git?!?
• Graphical Clients: a non-exhaustive list, only things I have tried:
  • Sourcetree
  • Tower
  • GitKraken
  • Sublime Merge
• XKCD 1296, "Git Commit"
• The Git manual's Discussion section on git-commit, re: messages
• My quick command guide:
  • DON'T USE git commit -am 'terrible message'!
  • git reset HEAD~ = commit undo
  • git add -p or git add --patch = stage partial lines/chunks for file(s)
  • git checkout --ours and git checkout --theirs = very simple resolutions for merge conflicts
  • git cherry-pick [HASH] = adds arbitrary commit changes to tip of current branch
  • git rebase -i [REF] = oh man, uhhh Read The Manual

Code Quality Tools

• The OG, lint
• pylint
• flake8
  • flake8-bandit
  • flake8-bugbear
• isort
• 2to3 in the standard library
• pyupgrade
• black
• yapf
• pre-commit

Also, a special highlight for tools for code quality highlighted by Amethyst Reese in her PyCon 2022 talk, Open Source on Easy Mode (youtube):

• usort
• ufmt
• thx

Pull Requests

Lots of resources are available from each provider of common git platforms with pull request tools. For a more general or philosophical take, I really like the writing of Chelsea Troy on this topic.

Dependency Management

• XKCD 1987, "Python Environment"
• Poetry
• Python Speed

Also, for even more detail, see Bootstrapping Your Local Python Environment, by Calvin Hendryx-Parker, PyCon US 2022 (youtube)