Show your Todoist Stats automatically on your GitHub profile readme 📝

I use Todoist and Notion App, a lot for organizing my work and maintaining my Timeline. I actually had this idea of automating and showing todoist stats on my README (as Notion doesn’t have it’s own API till now), a long back when GitHub launched their Profile README's, but due to some work and busy schedule , I’m not able to work on this, but few days ago, I saw DEV’s post regarding GitHub Actions hackathon in collaboration with GITHUB. That’s when I thought, It’s the best time to work on this automation stuff.

Fast Forward to today: I build this automation in just 3 Days, Published it, and also using it!

todoist readme
Fig 1. Todoist Stats, in README.

Todoist Workflow:

Todoist Readme just needs your TODOIST_API_KEY, and if you’re PREMIUM user, we have some features also for you guy’s 😉

Please follow the steps below in order to try this out in you’re readme too :

1️⃣ - Go to your <username>/<username>/actions, hit New workflow, set up a workflow yourself, delete all the default content github made for you.

2️⃣ - Choose the Workflow, based on you’re PREMIUM membership 💸

✅ Repository Workflow For Non-Premium Users:

  name: Todoist Readme

  on:
    workflow_dispatch:
    schedule:
      # Runs every minute 
      - cron: '* * * * *'

  jobs:
    update-readme:
      name: Update todoist stats
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v2
        - uses: abhisheknaiidu/todoist-readme@master
          with:
            TODOIST_API_KEY: $

✅ Repository Workflow For Premium Users:

  name: Todoist Readme

  on:
    workflow_dispatch:
    schedule:
      # Runs every minute 
      - cron: '* * * * *'

  jobs:
    update-readme:
      name: Update todoist stats
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v2
        - uses: abhisheknaiidu/todoist-readme@master
          with:
            TODOIST_API_KEY: $
            PREMIUM: true

3️⃣ - Voila! Now go to your profile page. you will be able to see it 🎉

It’s also Available on GitHub MarketPlace
Project is on GitHub: abhisheknaiidu/todoist-readme