From 071f887bd2d15bc6c10970a1a0b9f19159cb016a Mon Sep 17 00:00:00 2001 From: tcsenpai Date: Tue, 19 Nov 2024 23:07:23 +0100 Subject: [PATCH] updated binaries and instructions --- README.md | 30 ++++++++++++++++++++++++++++++ install.sh | 25 +++++++++++++++++++++++++ youlama | 12 ++++++++++++ 3 files changed, 67 insertions(+) create mode 100755 install.sh create mode 100755 youlama diff --git a/README.md b/README.md index fcb082c..d947254 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,18 @@ YouTube Summarizer is a Streamlit-based web application that allows users to generate summaries of YouTube videos using AI-powered language models and optionally Whisper for transcription. +- [YouTube Summarizer by TCSenpai](#youtube-summarizer-by-tcsenpai) + - [Features](#features) + - [Installation](#installation) + - [Usage](#usage) + - [Global Installation](#global-installation) + - [Run with the included binary](#run-with-the-included-binary) + - [Dependencies](#dependencies) + - [Project Structure](#project-structure) + - [Contributing](#contributing) + - [License](#license) + - [Credits](#credits) + ![Screenshot](screenshot.png) ## Features @@ -62,6 +74,24 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen 6. Click the "Summarize" button to generate a summary of the video. +## Global Installation + +You can install the application globally on your system by running the following command: + +``` +sudo ./install.sh +``` + +This will create a new command `youlama` that you can use to run the application. + +## Run with the included binary + +You can also run the application with the included binary: + +``` +./youlama +``` + ## Dependencies - Streamlit diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..9ec15e8 --- /dev/null +++ b/install.sh @@ -0,0 +1,25 @@ +#! /bin/bash + +# Ensure the script is run with sudo +if [ "$EUID" -ne 0 ]; then + echo "Please run this script with sudo" + exit 1 +fi + +# Install dependencies +pip install -r requirements.txt || exit 1 + +# Get the directory of the script +DIR=$(pwd) + +# Create a proper executable +CURRENT_DIR=$(pwd) +CMD=""" +#!/bin/bash + +cd $CURRENT_DIR +streamlit run src/main.py +""" + +echo "$CMD" > /usr/local/bin/youlama +chmod +x /usr/local/bin/youlama diff --git a/youlama b/youlama new file mode 100755 index 0000000..8af9991 --- /dev/null +++ b/youlama @@ -0,0 +1,12 @@ +#!/bin/bash + +# Install dependencies +if [ ! -f .installed ]; then + echo "Installing dependencies..." + pip install -r requirements.txt || exit 1 + touch .installed +fi + +# Run the app +echo "Running the app..." +streamlit run src/main.py