Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abhisheknaiidu/todoist-readme

🚧 Updates README with Todoist Stats of a user
https://github.com/abhisheknaiidu/todoist-readme

github-actions github-readme time-tracker todoist todoist-api todoist-tasks

Last synced: about 1 month ago
JSON representation

🚧 Updates README with Todoist Stats of a user

Awesome Lists containing this project

README 

        


  

  
🚧 Todoist Stats


  
⚡️📌 Update your Todoist Stats ✅ 



---



## Setup



### Prep work



1. You'll need a Todoist API Token. You can get that from [here](https://beta.todoist.com/prefs/integrations)

   - if you're new to Todoist, then you can refer [here](#new-to-todoist).

2. You need to save the Todoist API Token in the repository secrets. You can find that in the Settings of your Repository. Be sure to save those as the following.

   - `TODOIST_API_KEY = `

3. You need to update the README file(README.md) with 2 comments. You can refer [here](#update-your-readme) for updating it.



## Update your README



Add a comment to your `README.md` like this:



```markdown

# Todoist Stats



```



These lines will be our entry-points for the todoist stats.



## New to Todoist



Todoist gives you the confidence that everything’s organized and accounted for, so you can make progress on the things that are important to you.



- Create a Todoist account from [here](https://todoist.com/users/showregister)

- Get your Todoist API Key from your [here](https://beta.todoist.com/prefs/integrations)



### Repository Workflow For Non-Premium Users



Please follow the steps below:



1. Go to your `//actions`, hit `New workflow`, `set up a workflow yourself`, delete all the default content github made for you.

2. Copy the following code and paste it to your new workflow you created at step 1:



```yml

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: ${{ secrets.TODOIST_API_KEY }}

          PREMIUM: ""

```



3. Go to your repo secrets by hitting `Settings => Secrets` tab in your profile repo. You can also enter the url https://github.com/USERNAME/USERNAME/settings/secrets . Please replace the `USERNAME` with your own username.

4. Create a new `Secret`. `Name`: `TODOIST_API_KEY`, `Value`: Paste the Todoist API Token here. If you don't know what is the token, please go to [here](https://beta.todoist.com/prefs/integrations) to find your API Key there.

5. Add a comment to your `README.md` like this:



```markdown

# Todoist Stats



```



6. Go to Workflows menu (mentioned in step 1), click `Todoist Readme`, and click `Run workflow`.

7. Go to your profile page. you will be able to see it.



### Repository Workflow For Premium Users



Please follow the steps below:



1. Go to your `//actions`, hit `New workflow`, `set up a workflow yourself`, delete all the default content github made for you.

2. Copy the following code and paste it to your new workflow you created at step 1:



```yml

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: ${{ secrets.TODOIST_API_KEY }}

          PREMIUM: true

```



3. Remaining Steps will be same as Non-Premium Users.



## License



[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)



To the extent possible under law, [Abhishek Naidu](https://abhisheknaidu.tech/) has waived all copyright and related or neighboring rights to this work.



_Inspired by [yg/todoist-box](https://github.com/yg/todoist-box)_



_Inspired by [gautamkrishnar/blog-post-workflow](https://github.com/gautamkrishnar/blog-post-workflow)_