Metadata-Version: 2.1
Name: mtabe
Version: 1.6.0
Summary: An AI-powered CLI for adding notes and generating flashcards, tests, and chat summaries.
Home-page: https://github.com/Henryle-hd/mtabe
Author: Henrylee
Author-email: henrydionizi@gmail.com
Keywords: cli ai notes flashcards
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: click <9.0,>=8.1.8
Requires-Dist: colorama <0.5,>=0.4.6
Requires-Dist: rich <15.0,>=14.0.0
Requires-Dist: pandas <3.0,>=2.2.3
Requires-Dist: openpyxl <4.0,>=3.1.5
Requires-Dist: xlrd <3.0,>=2.0.1
Requires-Dist: python-docx <2.0,>=1.1.2
Requires-Dist: PyPDF2 <4.0,>=3.0.1
Requires-Dist: python-pptx <2.0,>=1.0.2
Requires-Dist: requests <3.0,>=2.32.3
Requires-Dist: beautifulsoup4 <5.0,>=4.13.4
Requires-Dist: pyfiglet <2.0,>=1.0.2
Requires-Dist: python-dotenv <2.0,>=1.1.0
Requires-Dist: groq <1.0,>=0.23.1
Requires-Dist: yt-dlp <2026.0,>=2025.5.22


# MTABE CLI - Your AI Study Assistant 🎓

MTABE is a powerful CLI tool that helps you study smarter using AI-powered flashcards and tests. It works with various content sources including YouTube videos, web pages, and local files.

## Installation

```bash
pip install mtabe
```

## Features

- 📝 Create AI-powered flashcards from any study material
- 📝 Generate custom tests with various question types
- 📺 Extract content from YouTube video subtitles
- 🌐 Pull study material from web pages
- 📄 Support for multiple file formats (PDF, DOCX, TXT, XLSX, etc.)

## Usage

### Adding Study Notes

```bash
# Add notes by typing/pasting
mtabe add mynotes -t

# Add notes from a YouTube video
mtabe add physics-lecture -y "https://youtube.com/watch?v=xxxxx"

# Add notes from a webpage
mtabe add chemistry-notes -w "https://example.com/chemistry-lesson"

# Add notes from a local file
mtabe add math-formulas -l "path/to/your/file.pdf"
```

### Creating Flashcards

```bash
# Create flashcards from saved notes
mtabe flash -f mynotes

# Create flashcards directly from YouTube
mtabe flash -y "https://youtube.com/watch?v=xxxxx"

# Create flashcards from a webpage
mtabe flash -w "https://example.com/lesson"

# Create flashcards from a local file
mtabe flash -l "path/to/your/file.pdf"
```

### Generating Tests

```bash
# Generate test from saved notes
mtabe test -f mynotes

# Generate test from YouTube content
mtabe test -y "https://youtube.com/watch?v=xxxxx"

# Generate test from a webpage
mtabe test -w "https://example.com/lesson"

# Generate test from a local file
mtabe test -l "path/to/your/file.pdf"
```

## Supported File Formats

- Text files (.txt)
- PDF documents (.pdf)
- Word documents (.docx)
- Excel spreadsheets (.xlsx, .xls, .xlsm)
- PowerPoint presentations (.pptx)
- CSV files (.csv)

## First-Time Setup

On first use, MTABE will prompt you to:
1. Enter your Groq API key (get it from https://console.groq.com/keys)
2. Provide your name
3. Specify your education level
4. Define your area of focus (IT, CS, Science, etc.)

This information helps MTABE personalize your learning experience.

## Tips for Best Results

- When requesting flashcards, specify the number you want (e.g., "Give me 10 cards")
- For tests, you can specify question types:
  - Multiple choice
  - True/false
  - Essay
  - Fill in the blank
  - Short explanation
  - Short answer
  - Mix of different types

## Example Commands

```bash
# Create 10 flashcards from a YouTube lecture
mtabe flash -y "https://youtube.com/watch?v=xxxxx"

# Generate a mixed test from saved notes
mtabe test -f chemistry-notes

# Add notes from a PDF textbook
mtabe add chapter5 -l "textbook/chapter5.pdf"
```
