Hugging Face's logo

Spaces:
dat-lequoc
/
pdf-flashcards-autogen
Runtime error

App Files Community
pdf-flashcards-autogen
File size: 2,452 Bytes 
417ad57
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# PDF Flashcard Generator: AI Study Companion

Unlock the power of your PDFs with AI-driven learning! This web application transforms your documents into interactive flashcards and explanations using Claude AI, perfect for importing into **ANKI**. Ideal for students, researchers, and lifelong learners looking to supercharge their study sessions and spaced repetition practice.

![image](https://github.com/user-attachments/assets/c82dc51e-588e-4d14-b399-34c6784d5d99)

## Key Features:
- 📚 Upload and view PDFs directly in your browser
- 🤖 Generate flashcards and explanations with Claude AI
- 🖍️ Highlight important text for focused learning
- 💾 Save and export your flashcard collections to **ANKI**-compatible format
- 📱 Responsive design for desktop and mobile use
- 🔄 Seamless integration with **ANKI** for optimized spaced repetition

Dive into your documents, emerge with knowledge at your fingertips, and supercharge your **ANKI** decks!

## Getting Started

### Prerequisites

- Python 3.7+
- Flask
- Anthropic API key

### Installation

1. Clone the repository:
   ```
   git clone https://github.com/quocdat-le-insacvl/pdf-flashcards-autogen.git
   cd pdf-flashcards-autogen
   ```

2. Install the required packages:
   ```
   pip install -r requirements.txt
   ```

3. Set up your Anthropic API key:
   - Sign up for an API key at [https://www.anthropic.com](https://www.anthropic.com)
   - Add your API key to the application when prompted

### Running the Application

1. Start the Flask server:
   ```
   python app.py
   ```

2. Open your web browser and navigate to `http://localhost:5000`

## Usage

1. Upload a PDF file using the file input at the top of the page
2. Navigate through the PDF using the page controls or by scrolling
3. Select text in the PDF viewer
4. Click "Generate Flashcard" to create flashcards from the selected text
5. View, remove, or export generated flashcards
6. Use the highlight mode to mark important text in the PDF

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For discussing improvements or new features, we encourage you to open an Issue first to facilitate community discussion.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- [PDF.js](https://mozilla.github.io/pdf.js/) for PDF rendering
- [Anthropic](https://www.anthropic.com) for the Claude AI API