BOLD FISH

Use large language model (LLM) and Bionic Reading to enhance the creation of Anki flashcards and learning from them!

What is it? 🔥

It is a software application that combines the following three actions:

assigns definitions to the indicated concepts using the OpenAI API (Generative Pre-trained Transformer model; gpt-3.5-turbo by default)
formats definitions to Bionic Reading (BR) format
Creates a ready-to-use deck of Anki flashcards

Who is the preferred user? 👋

It is intended for students and professionals who, like the author, have tendencies to list entities on the margin.

The application solves the problem of time-consuming preparation of simple flashcards, and additionally revises texts so that the most concise parts of words are highlighted based on BR method

a reading system that supports the reading flow (the eye is guided through the text using of typographic highlights, more about: https://bionic-reading.com/br-about/)

Why you should try? 💡

Flashcards enhance active recall, enhance memorization, and offer portable, efficient learning. They engage your memory effectively for better understanding and retention.
Skim, annotate, and visualize for deep comprehension. Summarize and adapt for optimal retention. Navigate seamlessly, conquer distractions. Elevate study efficiency in the digital era.

Requirements to run 🚀

In order to run the package, you must know the basics of Poetry: https://python-poetry.org/docs/

To use the deck, check https://docs.ankiweb.net/getting-started.html

How it works? 🚁

Using as class methods:

from boldfish import Boldfish

# to use OpenAI to assign definitions
OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY") 

# to use Bionic Reading on definitions
BIONIC_READING_X_RAPID_API_KEY = os.environ.get("BIONIC_READING_X_RAPID_API_KEY") 

# only to assign definitions or create Anki deck
boldfish = Boldfish(OPENAI_API_KEY)

# or

"""
    openai.api_key value automatically by reading it from an environment variable
    named OPENAI_API_KEY. The OpenAI Python library is designed to check for this
    environment variable by default
"""
boldfish = Boldfish()

# to assign definitions, allow format using Bionic Reading or create Anki deck
boldfish = Boldfish(OPENAI_API_KEY, BIONIC_READING_X_RAPID_API_KEY)


# example to assign the definitions, based on string input or the path
definitions = boldfish.get_definitions("fish")
definitions = boldfish.get_definitions("fish, Python, Anki")
definitions = boldfish.get_definitions("./data/test.csv")
definitions = boldfish.get_definitions("./data/test.json")

# to create the deck
# definitions: dictionary entity:'definition'
boldfish.create_deck_of_flashcards(definitions, 
                                   "<<deckName>>",
                                   "<<output-path>>")

Using the CLI:

poetry run python app/cli.py

Anki BR card example:

Log example (CLI):

Output example (CLI):

Externally provided API 🔗

To use this package you need to provide 2 keys in the .env file: OPENAI_API_KEY and BIONIC_READING_X_RAPID_API_KEY. To get them, you need to create accounts on the API providers website. The use of these APIs is free only under certain conditions. Please refer to the documentation to verify costs.

If you have trouble using the .env file, please check:

poetry env remove 3.10  
sudo poetry cache clear --all pypi
env $(cat .env) poetry shell  
poetry install
poetry run python app/cli.py

Testing and security 🚓

Coverage goal before the initial release of v1.0.0 is 100%, including unit, time performance and end-to-end tests.

All stay within localhost (excluding potential data leakage to vendors based on their license - check the terms of use of the API before use).

Comment for those intrigued by the name of the package

If you are intrigued by the name of the package: flashcards in Polish (fiszki) sound similar to the word fish, hence the idea for the name. Have a nice day! 🐟

ozieblo-michal / boldfish Goto Github PK

boldfish's Introduction