◐ Shell
clean mode source ↗

Sample code for: How to Use GitHub by lpozo · Pull Request #783 · realpython/materials

Where to put new files:

  • New files should go into a top-level subfolder, named after the article slug. For example: my-awesome-article

How to merge your changes:

  1. Make sure the CI code style tests all pass (+ run the automatic code formatter if necessary).
  2. Find an RP Team member on Slack and ask them to review & approve your PR.
  3. Once the PR has one positive ("approved") review, GitHub lets you merge the PR.
  4. 🎉

Code examples for the How to Use GitHub tutorial. Files live in the how-to-use-github/ top-level folder, named after the article slug.

The tutorial uses a small weather CLI app as the sample project and walks through fixing a bug through GitHub Issues, so the folder includes two snapshots of the script:

  • weather.py — the initial app as first created and pushed in the tutorial.
  • weather_fixed.py — the version after applying the Issue Flask API Tutorial #2 fix (loads secrets.ini relative to the script's location using pathlib).

Generated from the tutorial markdown with the post-materials skill, then verified locally before pushing.