https://github.com/jadogg/sbx

📚📦 StudyBox (SBX) - Terminal Flashcards & Library
https://github.com/jadogg/sbx

console-application flashcards lib library markdown prompt-toolkit python study terminal terminal-app terminal-based

Last synced: 17 days ago
JSON representation

📚📦 StudyBox (SBX) - Terminal Flashcards & Library

• Host: GitHub
• URL: https://github.com/jadogg/sbx
• Owner: JaDogg
• License: mit
• Created: 2020-05-25T11:46:08.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-07-20T11:34:46.000Z (over 1 year ago)
• Last Synced: 2024-10-13T21:49:03.250Z (about 1 month ago)
• Topics: console-application, flashcards, lib, library, markdown, prompt-toolkit, python, study, terminal, terminal-app, terminal-based
• Language: Python
• Homepage: https://jadogg.github.io/sbx/
• Size: 354 KB
• Stars: 16
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📚📦 StudyBox (SBX) - Terminal Flashcards

![screenshot](https://github.com/JaDogg/sbx/blob/develop/images/screenshot1.png?raw=true "Screenshot")

[![PyPI version](https://badge.fury.io/py/sbx.svg)](https://badge.fury.io/py/sbx)

[![Python: 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://github.com/JaDogg/sbx)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://timothycrosley.github.io/isort/)

----------------------------------

* 👉👉 [Guide & Library Documentation](https://jadogg.github.io/sbx/)

* 👉👉 [Tutorial - Flashcard study session without leaving your terminal](https://pandabunnytech.com/flashcard-study-in-terminal/)

----------------------------------

## 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)

```bash

pipx install sbx

```

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

### Install latest with pipx

```bash

git clone [email protected]:JaDogg/sbx.git

cd sbx

pipx install .

```

### Install latest with setup.py

```bash

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.