{"id":23085929,"url":"https://github.com/yeyom/notes-to-flashcards","last_synced_at":"2026-05-07T06:36:50.752Z","repository":{"id":268044812,"uuid":"901507335","full_name":"YeyoM/notes-to-flashcards","owner":"YeyoM","description":"Convert your study guides or notes into flashcards! Using LLMs obviously haha","archived":false,"fork":false,"pushed_at":"2025-02-22T17:04:25.000Z","size":84,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-22T18:19:19.983Z","etag":null,"topics":["ai","docker","docker-compose","flashcards","llm","mistral","ollama","python","study-guide","study-notes","university"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YeyoM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-10T19:35:40.000Z","updated_at":"2025-02-22T17:04:29.000Z","dependencies_parsed_at":"2024-12-14T02:25:51.495Z","dependency_job_id":"580ba32a-2c35-4b99-ad3c-fc3f99b499f9","html_url":"https://github.com/YeyoM/notes-to-flashcards","commit_stats":null,"previous_names":["yeyom/notes-to-flashcards"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YeyoM%2Fnotes-to-flashcards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YeyoM%2Fnotes-to-flashcards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YeyoM%2Fnotes-to-flashcards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YeyoM%2Fnotes-to-flashcards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YeyoM","download_url":"https://codeload.github.com/YeyoM/notes-to-flashcards/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247027470,"owners_count":20871548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","docker","docker-compose","flashcards","llm","mistral","ollama","python","study-guide","study-notes","university"],"created_at":"2024-12-16T18:13:28.425Z","updated_at":"2026-05-07T06:36:45.732Z","avatar_url":"https://github.com/YeyoM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flashcard Generator\n\nFlashcard Generator is a Python-based tool designed to create question-answer flashcards from study material. This project leverages the Ollama API to transform structured content, such as Markdown files, into comprehensive flashcards, making learning more efficient.\n\n---\n\n## Features\n\n- **Ollama API Integration**: Connects to the Ollama API to generate flashcards from your content.\n- **Model Management**: Automatically pulls and verifies models for processing.\n- **Markdown Parsing**: Reads, cleans, and processes study guides in Markdown format.\n- **Section Division**: Splits study material into manageable sections for better flashcard generation.\n- **Customizable Outputs**: Generates flashcards in English or Spanish, adhering to strict formatting rules.\n\n---\n\n## Installation and Usage\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/YeyoM/notes-to-flashcards.git\n   cd notes-to-flashcards\n   ```\n\n2. Place your study material in the `study_guides` directory with the name `study_guide.md`:\n\n   ```plaintext\n   notes-to-flashcards\n   ├── study_guides\n   │   └── study_guide.md\n   ```\n\n   Note 1: The study guide should be in Markdown format.\n   Note 2: For better results, use headings to divide the content into sections. (e.g., `# Chapter 1: Basics`)\n\n3. Run docker-compose:\n\n   Using docker compose, you can run the following command:\n\n   ```bash\n   docker-compose up # or docker-compose up --build to rebuild the images\n   ```\n\n---\n\n## Configuration\n\n- **Model**: By default, the generator uses the `mistral` model. You can modify this in the `FlashcardGenerator` class.\n- **Content Parsing**: Only Markdown files are currently supported. Other formats will return an empty string.\n\n---\n\n## Example Output\n\n### Input\n\n```markdown\n# Chapter 1: Basics\n\n- Python is a programming language.\n- It is used for web development, data analysis, and more.\n```\n\n### Output\n\n```plaintext\nQ1:\nWhat is Python?\n\nA1:\nPython is a programming language used for web development, data analysis, and other applications.\n```\n\nNote: You will see that before running the script, there are already some flashcards generated in the `flashcards` directory, these are some examples of the output and will be overwritten when you run the script.\n\n---\n\n## Contributions\n\nContributions are welcome! Feel free to fork the repository and submit pull requests with enhancements or bug fixes.\n\n---\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyeyom%2Fnotes-to-flashcards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyeyom%2Fnotes-to-flashcards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyeyom%2Fnotes-to-flashcards/lists"}