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:8501/.

Alternatively, use Docker

docker run -p 8501:8501 gabrielrphub/germanki:latest

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

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.9.tar.gz (45.5 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.9-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: germanki-0.2.9.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.0 CPython/3.11.11 Linux/6.8.0-1021-azure

File hashes

Hashes for germanki-0.2.9.tar.gz
Algorithm Hash digest
SHA256 d612354f2120dd9709ab3334aca9a0d1598e8b0df0578aa6ef43df52f3483057
MD5 94ce6853ed778a06c0cf24638efcc5b6
BLAKE2b-256 5a983995b6c9327e782d6ca50a958a5851b7b1a469ce132fbab932d0c2f72273

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for germanki-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 95b243dbf19f283dd0ed95a40e7ed468339bd99fda3ea315f641b85dff4aa4b2
MD5 a1aa7fb7a4a72111c4fcc323afb0dd5f
BLAKE2b-256 b45a03b40aae4a38ea8b15f8edd194b3bf511b311fe9e8a61822f50b44dd141b

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