Omid-sar commited on
Commit
3c38434
1 Parent(s): f3755b9
Files changed (1) hide show
  1. README.md +68 -1
README.md CHANGED
@@ -10,4 +10,71 @@ pinned: false
10
  license: openrail
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: openrail
11
  ---
12
 
13
+ # YouTube Context Explorer
14
+
15
+ ## Goal
16
+
17
+ The goal of this application is to facilitate the generation of engaging content suggestions and scripts for YouTube videos based on user-input topics. By leveraging OpenAI's language models and Wikipedia research, the application aims to provide captivating and unique content ideas and initiate scripts optimized for 5-minute videos, all while maintaining a friendly tone.
18
+
19
+ ## Overview
20
+
21
+ The application is built using Streamlit and the langchain library, creating an interactive user interface where users can input YouTube video topics and tags. The application generates title suggestions based on the input topic, allows users to select a title, input tags, and then generates a script incorporating the selected title, tags, and Wikipedia research related to the title.
22
+
23
+ ## Features
24
+
25
+ - **YouTube Topic Input**: Accepts user-input YouTube video topics to generate content suggestions.
26
+ - **Title Suggestions Generation**: Generates five engaging content suggestions using OpenAI's language models and displays them for user selection.
27
+ - **Tags Input**: Allows users to input tags for the script generation.
28
+ - **Script Generation**: Generates an engaging script incorporating the selected title, tags, and Wikipedia research.
29
+ - **Interactive User Interface**: Utilizes Streamlit for an interactive and user-friendly experience.
30
+
31
+ ## Prerequisites
32
+
33
+ - Python 3.x
34
+ - Streamlit
35
+ - OpenAI API Key
36
+ - langchain library
37
+
38
+ ## Setup and Installation
39
+
40
+ Clone the repository:
41
+
42
+ ```bash
43
+ git clone https://github.com/omid-sar/YouTube-Assistant-LangChain.git
44
+ cd YouTube-GPT-Creator
45
+ ```
46
+
47
+ Install the required libraries:
48
+
49
+ ```bash
50
+ pip install -r requirements.txt
51
+ ```
52
+
53
+ Set up your OpenAI API key as an environment variable:
54
+
55
+ ```bash
56
+ export OPENAI_API_KEY=your_api_key_here
57
+ ```
58
+
59
+ ## Usage
60
+
61
+ Run the Streamlit app:
62
+
63
+ ```bash
64
+ streamlit run app.py
65
+ ```
66
+
67
+ Open the app in your web browser, input the YouTube video topic and tags. Select a title from the generated suggestions and submit to generate and view the script based on the selected title, tags, and Wikipedia research.
68
+
69
+ ## Testing on Hugging Face Spaces
70
+
71
+ You can also test the application on Hugging Face Spaces by visiting [YouTube Context Explorer](https://huggingface.co/spaces/Omid-sar/YouTube_GPT_Creator). Follow the same usage steps to generate YouTube video scripts.
72
+
73
+ ## License
74
+
75
+ This project is licensed under the MIT License - see the [LICENSE](https://github.com/git/git-scm.com/blob/main/MIT-LICENSE.txt) file for details.
76
+
77
+
78
+
79
+
80
+