Metadata-Version: 2.1
Name: sbx
Version: 0.1.0
Summary: StudyBox (SBX) - Terminal Flashcards
Home-page: https://github.com/JaDogg/sbx
Author: Bhathiya Perera
Author-email: JaDogg@users.noreply.github.com
License: MIT
Keywords: study flashcard terminal
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: Pygments (>=2.6.1)
Requires-Dist: prompt-toolkit (>=3.0.5)
Requires-Dist: pytz (>=2020.1)
Requires-Dist: tzlocal (>=2.1)

# 📚📦 StudyBox (SBX) - Terminal Flashcards

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

[![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/)


## 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 git@github.com:JaDogg/sbx.git
cd sbx
pipx install .
```

### Install latest with setup.py
```bash
git clone git@github.com: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.



