https://github.com/mohit2152sharma/rewiser-gpt
Revise your daily devlogs with openai's gpt
https://github.com/mohit2152sharma/rewiser-gpt
Last synced: 4 months ago
JSON representation
Revise your daily devlogs with openai's gpt
- Host: GitHub
- URL: https://github.com/mohit2152sharma/rewiser-gpt
- Owner: mohit2152sharma
- Created: 2023-06-08T17:50:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T16:43:18.000Z (5 months ago)
- Last Synced: 2024-12-01T01:46:49.309Z (4 months ago)
- Language: Python
- Size: 418 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - mohit2152sharma/rewiser-gpt - Revise your daily devlogs with openai's gpt (Python)
README
# rewiser-gpt
A github action to manage your daily devlogs and help you revise them regularly.
## How it works?
Like a regular github action.
1. Hook this github-action to your devlog repository
2. Mention the directory and file type where all the devlogs are stored
3. The action will figure out the order of the files and will use anki style algorithm to create your daily roster.
4. It will send the daily roster via email, for emails to work, it will require smtp hostname and credentials.
You need to add a `yml` file in your `.github/workflows` folder to setup this action.
Here's a complete example of how to set it up, you can add a similar example to your `.github/workflows` folder:
```yml
# name of your action/workflow
name: Send Devlogs Rewiser Email
on:
# the schedule at which to send the email
schedule:
- cron: '30 01 * * *'
workflow_dispatch:
jobs:
send_email:
name: send email
runs-on: ubuntu-latest
steps:
# this checksout the github repository
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
# this sends the daily email
- name: Send devlog Email
uses: mohit2152sharma/[email protected]
with:
# all the following are required parameters
to_email: "[email protected]"
from_email: "[email protected]"
doc_directory: "devlogs"
smtp_hostname: ${{ secrets.SMTP_ENDPOINT }}
smtp_port: ${{ secrets.SMTP_PORT }}
smtp_username: ${{ secrets.SMTP_USERNAME }}
smtp_password: ${{ secrets.SMTP_PASSWORD }}
openai_api_key: ${{ secrets.openai_api_key }}
```
If you provide an `OPENAI_API_KEY`, it will generate questions for texts available in the files. At the moment, each item of a numbered list is treated as a separate text and questions are generated for each of these texts. The output in email, looks as shown below:
