🌭 wurstGPT

WurstGPT is a learning companion for German language learners. Every day it will send you an email with 5 randomly sampled words from a list of the 1000 most common German words along with their translation and 5 example sentences generated by ChatGPT.

✉️ Example mail

Guetn Tag! I am wurstGPT, here are your daily german words:

1. dies - this
2. z.B. - e.g.
3. Informationen - information
4. stellen - provide
5. Chef - chief

Example sentences:
1. Dies ist mein Buch. (This is my book.)
2. Ich mag viele Sportarten, z.B. Fußball, Basketball und Tennis. (I like many sports, for example soccer, basketball, and tennis.)
3. Ich brauche mehr Informationen über das Thema. (I need more information about the topic.)
4. Kannst du mir bitte eine Frage stellen? (Can you please ask me a question?)
5. Mein Chef ist sehr nett und hilfsbereit. (My boss is very kind and helpful.)

Tschüss!

🇩🇪 Dataset

I used a Quizlet study set containing the 1000 most common German words. I manually exported the set as a CSV file and saved it as quizlet.csv in the data folder.

🔧 Setup

1. Clone the repository.
2. Set up your Github secrets:

• EMAIL: Your email address.
• EMAIL_PASSWORD: Your gmail app password.
• API_KEY: Your OpenAI API key.

3. To test locally, set up the environment variables and a virtual environment with poetry.
4. Run poetry run python wurstgpt/main.py to send a test email.
5. Enjoy learning German, every day at 9 AM (UTC) a GitHub Action is triggered.