Auto-Updating Your Github Readme With Python

Auto-Updating Your Github Readme With Python

## Auto-Updating Your Github Readme With Python on Medium by Dylan Roy @ https://medium.com/@dylanroy

cron.yml

name: cron

on:
  push:
    branches:
      - master
  schedule:
    - cron: "5 5 * * *"

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: 🍽️ Get working copy
        uses: actions/checkout@master
        with:
          fetch-depth: 1                                                                 
      - name: 🐍 Set up Python 3.8                               
        uses: actions/setup-python@v2                               
        with:                                 
          python-version: '3.8'                                                   
      - name: 💿 Install feedparser & pytz                              
        run: pip install feedparser pytz
      - name: 🍳 Update README
        run: |
          cd ${GITHUB_WORKSPACE}/src/
          python main.py
      - name: 🚀 Deploy
        run: |
          git config user.name "${GITHUB_ACTOR}"
          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git add .
          git commit -am "feat(auto generate): Updated content"
          git push --all -f https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git

cron_1.yml

name: cron

on:
  push:
    branches:
      - master
  schedule:
    - cron: "5 5 * * *"

cron_2.yml

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

cron_3.yml

    steps:
      - name: 🍽️ Get working copy
        uses: actions/checkout@master
        with:
          fetch-depth: 1                                                                 
      - name: 🐍 Set up Python 3.8                               
        uses: actions/setup-python@v2                               
        with:                                 
          python-version: '3.8'                                                   
      - name: 💿 Install feedparser & pytz                              
        run: pip install feedparser pytz

cron_4.yml

      - name: 🍳 Update README
        run: |
          cd ${GITHUB_WORKSPACE}/src/
          python main.py

cron_5.yml

      - name: 🚀 Deploy
        run: |
          git config user.name "${GITHUB_ACTOR}"
          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git add .
          git commit -am "feat(auto generate): Updated content"
          git push --all -f https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git

main.py

from pathlib import Path
import datetime
import pytz

import feedparser

def update_footer():
    timestamp = datetime.datetime.now(pytz.timezone("Europe/Madrid")).strftime("%c")
    footer = Path('../FOOTER.md').read_text()
    return footer.format(timestamp=timestamp)

def update_readme_medium_posts(medium_feed, readme_base, join_on):
    d = feedparser.parse(medium_feed)
    posts = []
    for item in d.entries:
        if item.get('tags'):
            posts.append(f" - [{item['title']}]({item['link']})")
    posts_joined = '\n'.join(posts)
    return readme_base[:readme_base.find(rss_title)] + f"{join_on}\n{posts_joined}"

rss_title = "### Stories by Dylan Roy on Medium" # Anchor for where to append posts
readme = Path('../README.md').read_text()
updated_readme = update_readme_medium_posts("https://medium.com/feed/@dylanroy", readme, rss_title)
with open('../README.md', "w+") as f:
    f.write(updated_readme + update_footer())

snippet_1.py

def update_readme_medium_posts(medium_feed, readme_base, join_on):
    d = feedparser.parse(medium_feed)
    title = f"### {d['feed']['title']}"
    posts = []
    for item in d.entries:
        if item.get('tags'):
            posts.append(f" - [{item['title']}]({item['link']})")
    posts_joined = '\n'.join(posts)
    return readme_base[:readme_base.find(rss_title)] + f"{title}\n{posts_joined}"

snippet_2.py

def update_footer():
    timestamp = datetime.datetime.now(pytz.timezone("Europe/Madrid")).strftime("%c")
    footer = Path('../FOOTER.md').read_text()
    return footer.format(timestamp=timestamp)

snippet_3.py

rss_title = "### Stories by Dylan Roy on Medium" # Anchor for where to append posts
readme = Path('../README.md').read_text()
updated_readme = update_readme_medium_posts("https://medium.com/feed/@dylanroy", readme, rss_title)
with open('../README.md', "w+") as f:
    f.write(updated_readme + update_footer())