Skip to main content

No project description provided

Project description

code style blue codecov Quality Gate Status

GermAnki

Make Anki German vocabulary card creation less time-consuming with GermAnki.

This is only possible thanks to AnkiConnect, TTSMP3, and Pexels. Thanks!

Features

  1. Automatically include pronunciation audio to your card.
  2. Automatically include a relevant image to your card.

ChatGPT Input Mode

If you have an OpenAI API key, Germanki will prompt ChatGPT and create all your card contents for you. Just enter the word or expressions you want to generate a card for.

Customizations

Change Speaker's Voice

Choose among available voices to pronounce the German text the front of your card.

Refresh Image

Is the first image pick not good enough? Click the Refresh Images button and get a new random one.

Requirements

  1. Install the AnkiConnect add-on.
  2. Add support these three fields in your Basic Anki card type: Front, Back, and Extra.

Optional:

  1. Create an account on Pexels and create your API key. It's free. Then set the environment variable PEXELS_API_KEY to your key.

    Required to have images in your cards

  2. Create an account on ChatGPT to generate inputs for you.

  3. Generate an OpenAI API Key and add it to Germanki so that it can generate the card contents for you.

    Required to have ChatGPT Input Mode

Run

  1. Clone this repository
  2. Install poetry

Then, inside the repository:

# install the dependencies
poetry install
# set your Pexels API key if you have one
export PEXELS_API_KEY=<your-api-key>
# set your OpenAI API key if you have one
export OPENAI_API_KEY=<your-api-key>
# run the app
poetry run germanki

Then go to http://localhost:8503/.

Anki Cards

By default, this is how the GermAnki is programmed to work.

Front:

  • The German word.
  • A pronunciation audio.

Back:

  • The English translations.
  • A relevant picture to help with memorization.

Extra:

  • Description, example, and other information relevant for the word type e.g. perfect form of verbs, article and plural form of nouns.

Example:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

germanki-0.2.2.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

germanki-0.2.2-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file germanki-0.2.2.tar.gz.

File metadata

  • Download URL: germanki-0.2.2.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1020-azure

File hashes

Hashes for germanki-0.2.2.tar.gz
Algorithm Hash digest
SHA256 8eed76e1b46d1bf3eb08ad8b096769259665622321c4079bf9927fdb0326be58
MD5 b5e86566964f48edc509273f1dd91d11
BLAKE2b-256 f95e522b1e3eb0b840156de9f6187437ed1c979a6102769d5ee843fefa2ca720

See more details on using hashes here.

File details

Details for the file germanki-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: germanki-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1020-azure

File hashes

Hashes for germanki-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fd944ec9328e9b767f28b7c72fcca46afbd3803f9e13fbaa15aa20dc7ff4d01
MD5 210543fc5844467f260cb48207244d30
BLAKE2b-256 c300e2973702e23ab20a957b94f9025f86cd9ba5a43656b4f7de685ffa22a011

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page