Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheel-ui/yt-summarizer
YT Summarizer is a web application that allows users to get summaries of YouTube videos with captions. Also, download the captions of YouTube videos in .txt or .srt format.
https://github.com/sheel-ui/yt-summarizer
django htmx htmx-django python tailwind
Last synced: 23 days ago
JSON representation
YT Summarizer is a web application that allows users to get summaries of YouTube videos with captions. Also, download the captions of YouTube videos in .txt or .srt format.
- Host: GitHub
- URL: https://github.com/sheel-ui/yt-summarizer
- Owner: Sheel-ui
- Created: 2024-06-11T16:30:02.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T17:43:10.000Z (8 months ago)
- Last Synced: 2024-11-14T21:09:24.254Z (3 months ago)
- Topics: django, htmx, htmx-django, python, tailwind
- Language: Python
- Homepage:
- Size: 291 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YT Summarizer
YT Summarizer is a web application that allows users to get summaries of YouTube videos with captions. The project is built using Python, Django, HTMX, Tailwind CSS, and the OpenAI API.
## Table of Contents
- [Features](#features)
- [Demo](#demo)
- [Interface](#interface)
- [Setup Instructions](#setup-instructions)
- [Technologies Used](#technologies-used)
## Features
- Download the captions of YouTube videos in `.txt` or `.srt` format.
- Get a summary of any YouTube video.
## Demo
### Interface
## Setup Instructions
To set up and run the application locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/Sheel-ui/yt-summarizer.git
```
2. **Create a virtual environment using Conda:**
```bash
cd yt-summarizer
```
3. **Create a virtual environment using Conda:**
```bash
conda create -n python=3.10
```
4. **Activate the virtual environment:**
```bash
conda activate
```
5. **Install the necessary dependencies:**
```bash
pip install -r requirements.txt
```
6. **Set up the OpenAI API key:**
- Create a `.env` file in the project root.
- Add your OpenAI API key to the `.env` file:
```
OPENAI_API_KEY=your_openai_api_key
```
7. **Run the Django development server:**
```bash
python manage.py runserver
```
## Technologies Used
- **Backend:** Python, Django
- **Frontend:** HTMX, Tailwind CSS
- **API:** OpenAI API