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.4.tar.gz (45.2 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.4-py3-none-any.whl (47.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: germanki-0.2.4.tar.gz
  • Upload date:
  • Size: 45.2 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.4.tar.gz
Algorithm Hash digest
SHA256 818b20d5c719081bed8726fa71a7c4d9b1b719f0ec8e83530e4586c58c23db98
MD5 021c2114a0cdde2eb5e6104409045536
BLAKE2b-256 5c0c2331a64c5425a3fc5f41126c63bb332639f172c70ef2f2e3433fa323c286

See more details on using hashes here.

File details

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

File metadata

  • Download URL: germanki-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 47.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9d173bd9466fdd40837f50ba236e682be01726f028b7fc12b7ae60f0af79c084
MD5 1ab5b3b31ca6096b077dbd6cccdb1939
BLAKE2b-256 bcf627102f44f6a79443361e199b680379abbc49ac27dd01a6c0517ec1385ae4

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