Skip to content
/ sbx Public

πŸ“šπŸ“¦ StudyBox (SBX) - Terminal Flashcards & Library

License

Notifications You must be signed in to change notification settings

JaDogg/sbx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“šπŸ“¦ StudyBox (SBX) - Terminal Flashcards

screenshot

PyPI version Python: 3.6+ Code style: black Imports: isort



Credits πŸ™‡β€β™‚οΈ

  • Sm2 - Algorithm by Super Memo
  • prompt-toolkit - TUI library. 😎

Why ? πŸ€”

  • Wanted a flashcard solution that uses markdown.
  • I wanted to memorise useful information.
  • GitHub/Gitlab/etc,.. readable flashcards.

Installation (Unix, Windows)

Install from PyPI (pipx)

pipx install sbx
  • Alternatively you can install it using pip3 install sbx (On some OSes this is pip install sbx)

Install latest with pipx

git clone [email protected]:JaDogg/sbx.git
cd sbx
pipx install .

Install latest with setup.py

git clone [email protected]:JaDogg/sbx.git
cd sbx
python setup.py install

Features

  • It's markdown. (You can use your own editor, as long as you maintain comments in it)
  • Syntax highlighting.
  • List files. (leech, last one marked with lowest score, include all, etc.)
  • Use your own folder structure. (Study at any level in your structure, recursive or not is up to you)
  • Built in editor which shows front and back of the flashcards.
  • Push your files to github and you can read them.

Copyright

This software is Copyright (c) 2020 - 2022 Bhathiya Perera.

See the LICENSE file for more information.