wiydarrr commited on
Commit
9396b39
โ€ข
1 Parent(s): 16da68a

Upload folder using huggingface_hub

Browse files
Files changed (2) hide show
  1. .gitattributes +39 -0
  2. README.md +203 -203
.gitattributes CHANGED
@@ -1,3 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  *.7z filter=lfs diff=lfs merge=lfs -text
2
  *.arrow filter=lfs diff=lfs merge=lfs -text
3
  *.bin filter=lfs diff=lfs merge=lfs -text
@@ -34,3 +72,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
  public/subscribe-animation.mp4 filter=lfs diff=lfs merge=lfs -text
 
 
1
+ <<<<<<< HEAD
2
+ *.7z filter=lfs diff=lfs merge=lfs -text
3
+ *.arrow filter=lfs diff=lfs merge=lfs -text
4
+ *.bin filter=lfs diff=lfs merge=lfs -text
5
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
6
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
7
+ *.ftz filter=lfs diff=lfs merge=lfs -text
8
+ *.gz filter=lfs diff=lfs merge=lfs -text
9
+ *.h5 filter=lfs diff=lfs merge=lfs -text
10
+ *.joblib filter=lfs diff=lfs merge=lfs -text
11
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
12
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
13
+ *.model filter=lfs diff=lfs merge=lfs -text
14
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
15
+ *.npy filter=lfs diff=lfs merge=lfs -text
16
+ *.npz filter=lfs diff=lfs merge=lfs -text
17
+ *.onnx filter=lfs diff=lfs merge=lfs -text
18
+ *.ot filter=lfs diff=lfs merge=lfs -text
19
+ *.parquet filter=lfs diff=lfs merge=lfs -text
20
+ *.pb filter=lfs diff=lfs merge=lfs -text
21
+ *.pickle filter=lfs diff=lfs merge=lfs -text
22
+ *.pkl filter=lfs diff=lfs merge=lfs -text
23
+ *.pt filter=lfs diff=lfs merge=lfs -text
24
+ *.pth filter=lfs diff=lfs merge=lfs -text
25
+ *.rar filter=lfs diff=lfs merge=lfs -text
26
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
27
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
28
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
29
+ *.tar filter=lfs diff=lfs merge=lfs -text
30
+ *.tflite filter=lfs diff=lfs merge=lfs -text
31
+ *.tgz filter=lfs diff=lfs merge=lfs -text
32
+ *.wasm filter=lfs diff=lfs merge=lfs -text
33
+ *.xz filter=lfs diff=lfs merge=lfs -text
34
+ *.zip filter=lfs diff=lfs merge=lfs -text
35
+ *.zst filter=lfs diff=lfs merge=lfs -text
36
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
37
+ public/subscribe-animation.mp4 filter=lfs diff=lfs merge=lfs -text
38
+ =======
39
  *.7z filter=lfs diff=lfs merge=lfs -text
40
  *.arrow filter=lfs diff=lfs merge=lfs -text
41
  *.bin filter=lfs diff=lfs merge=lfs -text
 
72
  *.zst filter=lfs diff=lfs merge=lfs -text
73
  *tfevents* filter=lfs diff=lfs merge=lfs -text
74
  public/subscribe-animation.mp4 filter=lfs diff=lfs merge=lfs -text
75
+ >>>>>>> 4306226c79ef9fbbd1c3ffa4696664a324eb6a90
README.md CHANGED
@@ -1,203 +1,203 @@
1
- ---
2
- title: sHORTgpt
3
- app_file: runShortGPT.py
4
- sdk: gradio
5
- sdk_version: 3.38.0
6
- ---
7
- # ๐Ÿš€๐ŸŽฌ ShortGPT
8
- [![](https://dcbadge.vercel.app/api/server/uERx39ru3R?compact=true&style=flat)](https://discord.gg/uERx39ru3R)
9
- [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/rayventurahq.svg?style=social&label=Follow%20%40RayVentura)](https://twitter.com/RayVenturaHQ)
10
- [![GitHub star chart](https://img.shields.io/github/stars/rayventura/shortgpt?style=social)](https://star-history.com/#rayventura/shortgpt)
11
- <div align="center">
12
- <img src="https://github.com/RayVentura/ShortGPT/assets/121462835/083c8dc3-bac5-42c1-a08d-3ff9686d18c5" alt="ShortGPT-logo" style="border-radius: 20px;" width="22%"/>
13
- </div>
14
- <div align="center">
15
- <a href="https://discord.gg/uERx39ru3R">
16
- <img src="https://img.shields.io/badge/discord-join%20chat-blue.svg" alt="Join our Discord" height="34">
17
- </a>
18
- </div>
19
-
20
- <div align="center">
21
- โšก Automating video and short content creation with AI โšก
22
- </div>
23
-
24
- ## ๐ŸŽฅ Showcase ([Full video on YouTube](https://youtu.be/hpoSHq-ER8U))
25
-
26
- https://github.com/RayVentura/ShortGPT/assets/121462835/a802faad-0fd7-4fcb-aa82-6365c27ea5fe
27
- ## ๐ŸŽฅ Voice Dubbing
28
-
29
-
30
- https://github.com/RayVentura/ShortGPT/assets/121462835/06f51b2d-f8b1-4a23-b299-55e0e18902ef
31
-
32
- ## ๐ŸŒŸ Show Your Support
33
- We hope you find ShortGPT helpful! If you do, let us know by giving us a star โญ on the repo. It's easy, just click on the 'Star' button at the top right of the page. Your support means a lot to us and keeps us motivated to improve and expand ShortGPT. Thank you and happy content creating! ๐ŸŽ‰
34
-
35
- [![GitHub star chart](https://img.shields.io/github/stars/rayventura/shortgpt?style=social)](https://github.com/RayVentura/ShortGPT/stargazers)
36
- ## ๐Ÿ› ๏ธ How it works
37
- ![alt text](https://github.com/RayVentura/ShortGPT/assets/121462835/fcee74d4-f856-4481-949f-244558bf3bfa)
38
- ## ๐Ÿ“ Introduction to ShortGPT
39
- ShortGPT is a powerful framework for automating content creation. It simplifies video creation, footage sourcing, voiceover synthesis, and editing tasks.
40
-
41
- - ๐ŸŽž๏ธ **Automated editing framework**: Streamlines the video creation process with an LLM oriented video editing language.
42
-
43
- - ๐Ÿ“ƒ **Scripts and Prompts**: Provides ready-to-use scripts and prompts for various LLM automated editing processes.
44
-
45
- - ๐Ÿ—ฃ๏ธ **Voiceover / Content Creation**: Supports multiple languages including English ๐Ÿ‡บ๐Ÿ‡ธ, Spanish ๐Ÿ‡ช๐Ÿ‡ธ, Arabic ๐Ÿ‡ฆ๐Ÿ‡ช, French ๐Ÿ‡ซ๐Ÿ‡ท, Polish ๐Ÿ‡ต๐Ÿ‡ฑ, German ๐Ÿ‡ฉ๐Ÿ‡ช, Italian ๐Ÿ‡ฎ๐Ÿ‡น, and Portuguese ๐Ÿ‡ต๐Ÿ‡น.
46
-
47
- - ๐Ÿ”— **Caption Generation**: Automates the generation of video captions.
48
-
49
- - ๐ŸŒ๐ŸŽฅ **Asset Sourcing**: Sources images and video footage from the internet, connecting with the web and Pexels API as necessary.
50
-
51
- - ๐Ÿง  **Memory and persistency**: Ensures long-term persistency of automated editing variables with TinyDB.
52
-
53
- ## ๐Ÿš€ Quick Start: Run ShortGPT on Google Colab (https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing)
54
-
55
- If you prefer not to install the prerequisites on your local system, you can use the Google Colab notebook. This option is free and requires no installation setup.
56
-
57
- 1. Click on the link to the Google Colab notebook: [https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing](https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing)
58
-
59
- 2. Once you're in the notebook, simply run the cells in order from top to bottom. You can do this by clicking on each cell and pressing the 'Play' button, or by using the keyboard . Enjoy using ShortGPT!
60
-
61
- # Instructions for running shortGPT
62
- This guide provides step-by-step instructions for installing ImageMagick and FFmpeg on your system, which are both required to do automated editing. Once installed, you can proceed to run `runShortGPT.py` successfully.
63
-
64
- ## Prerequisites
65
- Before you begin, ensure that you have the following prerequisites installed on your system:
66
- - Python 3.x
67
- - Pip (Python package installer)
68
-
69
- ## Installation Steps
70
- Follow the instructions below to install ImageMagick, FFmpeg, and clone the shortGPT repository:
71
-
72
- ### Step 1: Install ImageMagick
73
- 1. For `Windows` download the installer from the official ImageMagick website and follow the installation instructions.
74
-
75
- [https://imagemagick.org/script/download.php](https://imagemagick.org/script/download.php)
76
-
77
- 2. For Ubuntu/Debian-based systems, use the command:
78
- ```
79
- sudo apt-get install imagemagick
80
- ```
81
- Then run the following command to fix a moviepy Imagemagick policy.xml incompatibility problem:
82
- ```
83
- !sed -i '/<policy domain="path" rights="none" pattern="@\*"/d' /etc/ImageMagick-6/policy.xml
84
- ```
85
- 4. For macOS using Homebrew, use the command:
86
- ```
87
- brew install imagemagick
88
- ```
89
- 2. Verify the installation by running the following command:
90
- ```
91
- convert --version
92
- ```
93
- You should see the ImageMagick version information if the installation was successful.
94
-
95
- ### Step 2: Install FFmpeg (REQUIRED FOR SHORTGPT TO WORK)
96
- 1. For `Windows`Download the FFmpeg binaries from this Windows Installer (It will download ffmpeg, ffprobe and add it to your path).
97
-
98
- [https://github.com/icedterminal/ffmpeg-installer/releases/tag/6.0.0.20230306](https://github.com/icedterminal/ffmpeg-installer/releases/tag/6.0.0.20230306)
99
-
100
- 2. For macOS using Homebrew, use the command:
101
- ```
102
- brew install ffmpeg
103
- ```
104
- For Ubuntu/Debian-based systems, use the command:
105
- ```
106
- sudo apt-get install ffmpeg
107
- ```
108
- 2. Verify the installation by running the following command:
109
- ```
110
- ffmpeg -version
111
- ```
112
- You should see the FFmpeg version information if the installation was successful.
113
-
114
- ### Step 3: Clone the shortGPT Repository
115
-
116
- 1. Open a terminal or command prompt.
117
- 2. Execute the following command to clone the shortGPT repository:
118
- ```
119
- git clone https://github.com/rayventura/shortgpt.git
120
- ```
121
-
122
- ### Step 4: Install Python Dependencies
123
-
124
- 1. Open a terminal or command prompt.
125
- 2. Navigate to the directory where `runShortGPT.py` is located (the cloned repo).
126
- 3. Execute the following command to install the required Python dependencies:
127
- ```
128
- pip install -r requirements.txt
129
- ```
130
-
131
- This command will install the necessary packages specified in the `requirements.txt` file.
132
-
133
- ## Running runShortGPT.py Web Interface
134
-
135
- Once you have successfully installed ImageMagick, FFmpeg, and the Python dependencies, you can run `runShortGPT.py` by following these steps:
136
-
137
- 1. Open a terminal or command prompt.
138
- 2. Navigate to the directory where `runShortGPT.py` is located (the cloned repo).
139
- 3. Execute the following command to run the script:
140
- ```
141
- python runShortGPT.py
142
- ```
143
- 4. After running the script, a Gradio interface should open at your local host on port 31415 (http://localhost:31415).
144
-
145
- ## Putting API Keys
146
- The ShortGPT UI needs you to input at least OpenAI and ElevenLabs api keys for running short automations. For video automations, you will also need to add a Pexels API.
147
-
148
- Follow these steps to add your OpenAI and ElevenLabs API keys:
149
-
150
- 1. Open [http://localhost:31415/?__theme=light](http://localhost:31415/?__theme=light) from a web browser.
151
- 2. Click on the `config` tab located at the left side bar of the user interface.
152
- 3. Add your `OPENAI API KEY` and `ELEVENLABS API KEY` in the corresponding input fields.
153
- 4. Click `Save` to save your API keys.
154
-
155
- That's it! You have successfully set up your API keys and can now utilize the functionality of ShortGPT in the Gradio interface.
156
-
157
- ## Framework overview
158
-
159
- - ๐ŸŽฌ The `ContentShortEngine` is designed for creating shorts, handling tasks from script generation to final rendering, including adding YouTube metadata.
160
-
161
- - ๐ŸŽฅ The `ContentVideoEngine` is ideal for longer videos, taking care of tasks like generating audio, automatically sourcing background video footage, timing captions, and preparing background assets.
162
-
163
- - ๐ŸŽž๏ธ The automated `EditingEngine`, using Editing Markup Language and JSON, breaks down the editing process into manageable and customizable blocks, comprehensible to Large Language Models.
164
-
165
- ๐Ÿ’ก ShortGPT offers customization options to suit your needs, from language selection to watermark addition.
166
-
167
- ๐Ÿ”ง As a framework, ShortGPT is adaptable and flexible, offering the potential for efficient, creative content creation.
168
-
169
- More documentation incomming, please be patient.
170
-
171
-
172
- ## Technologies Used
173
-
174
- ShortGPT utilizes the following technologies to power its functionality:
175
-
176
- - **Moviepy**: Moviepy is used for video editing, allowing ShortGPT to make video editing and rendering
177
-
178
- - **Openai**: Openai is used for automating the entire process, including generating scripts and prompts for LLM automated editing processes.
179
-
180
- - **ElevenLabs**: ElevenLabs is used for voice synthesis, supporting multiple languages for voiceover creation.
181
-
182
- - **Pexels**: Pexels is used for sourcing background footage, allowing ShortGPT to connect with the web and access a wide range of images and videos.
183
-
184
- - **Bing Image**: Bing Image is used for sourcing images, providing a comprehensive database for ShortGPT to retrieve relevant visuals.
185
-
186
- These technologies work together to provide a seamless and efficient experience in automating video and short content creation with AI.
187
-
188
- ## ๐Ÿ’ Contributing
189
-
190
- As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it would be in the form of a new feature, improved infrastructure, or better documentation.
191
-
192
- ## ๐Ÿ”— Get in touch on Twitter ๐Ÿฆ
193
-
194
- Keep up with the latest happenings, announcements, and insights about Short-GPT by checking out our Twitter accounts. Spark a conversation with our developer and the AI's own account for fascinating dialogues, latest news about the project, and more.
195
-
196
- - **Developer**: Stay updated [@RayVentura](https://twitter.com/RayVenturaHQ). Deep-dive into behind-the-scenes, project news, and related topics from the person behind ShortGPT.
197
-
198
- We're eager to interact with you and listen to your feedback, concepts, and experiences with Short-GPT. Come on board on Twitter and let's navigate the future of AI as a team! ๐Ÿ’ก๐Ÿค–
199
- <p align="center">
200
- <a href="https://star-history.com/#RayVentura/ShortGPT&Date">
201
- <img src="https://api.star-history.com/svg?repos=RayVentura/ShortGPT&type=Date" alt="Star History Chart">
202
- </a>
203
- </p>
 
1
+ ---
2
+ title: sHORTgpt
3
+ app_file: runShortGPTColab.py
4
+ sdk: gradio
5
+ sdk_version: 3.38.0
6
+ ---
7
+ # ๐Ÿš€๐ŸŽฌ ShortGPT
8
+ [![](https://dcbadge.vercel.app/api/server/uERx39ru3R?compact=true&style=flat)](https://discord.gg/uERx39ru3R)
9
+ [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/rayventurahq.svg?style=social&label=Follow%20%40RayVentura)](https://twitter.com/RayVenturaHQ)
10
+ [![GitHub star chart](https://img.shields.io/github/stars/rayventura/shortgpt?style=social)](https://star-history.com/#rayventura/shortgpt)
11
+ <div align="center">
12
+ <img src="https://github.com/RayVentura/ShortGPT/assets/121462835/083c8dc3-bac5-42c1-a08d-3ff9686d18c5" alt="ShortGPT-logo" style="border-radius: 20px;" width="22%"/>
13
+ </div>
14
+ <div align="center">
15
+ <a href="https://discord.gg/uERx39ru3R">
16
+ <img src="https://img.shields.io/badge/discord-join%20chat-blue.svg" alt="Join our Discord" height="34">
17
+ </a>
18
+ </div>
19
+
20
+ <div align="center">
21
+ โšก Automating video and short content creation with AI โšก
22
+ </div>
23
+
24
+ ## ๐ŸŽฅ Showcase ([Full video on YouTube](https://youtu.be/hpoSHq-ER8U))
25
+
26
+ https://github.com/RayVentura/ShortGPT/assets/121462835/a802faad-0fd7-4fcb-aa82-6365c27ea5fe
27
+ ## ๐ŸŽฅ Voice Dubbing
28
+
29
+
30
+ https://github.com/RayVentura/ShortGPT/assets/121462835/06f51b2d-f8b1-4a23-b299-55e0e18902ef
31
+
32
+ ## ๐ŸŒŸ Show Your Support
33
+ We hope you find ShortGPT helpful! If you do, let us know by giving us a star โญ on the repo. It's easy, just click on the 'Star' button at the top right of the page. Your support means a lot to us and keeps us motivated to improve and expand ShortGPT. Thank you and happy content creating! ๐ŸŽ‰
34
+
35
+ [![GitHub star chart](https://img.shields.io/github/stars/rayventura/shortgpt?style=social)](https://github.com/RayVentura/ShortGPT/stargazers)
36
+ ## ๐Ÿ› ๏ธ How it works
37
+ ![alt text](https://github.com/RayVentura/ShortGPT/assets/121462835/fcee74d4-f856-4481-949f-244558bf3bfa)
38
+ ## ๐Ÿ“ Introduction to ShortGPT
39
+ ShortGPT is a powerful framework for automating content creation. It simplifies video creation, footage sourcing, voiceover synthesis, and editing tasks.
40
+
41
+ - ๐ŸŽž๏ธ **Automated editing framework**: Streamlines the video creation process with an LLM oriented video editing language.
42
+
43
+ - ๐Ÿ“ƒ **Scripts and Prompts**: Provides ready-to-use scripts and prompts for various LLM automated editing processes.
44
+
45
+ - ๐Ÿ—ฃ๏ธ **Voiceover / Content Creation**: Supports multiple languages including English ๐Ÿ‡บ๐Ÿ‡ธ, Spanish ๐Ÿ‡ช๐Ÿ‡ธ, Arabic ๐Ÿ‡ฆ๐Ÿ‡ช, French ๐Ÿ‡ซ๐Ÿ‡ท, Polish ๐Ÿ‡ต๐Ÿ‡ฑ, German ๐Ÿ‡ฉ๐Ÿ‡ช, Italian ๐Ÿ‡ฎ๐Ÿ‡น, and Portuguese ๐Ÿ‡ต๐Ÿ‡น.
46
+
47
+ - ๐Ÿ”— **Caption Generation**: Automates the generation of video captions.
48
+
49
+ - ๐ŸŒ๐ŸŽฅ **Asset Sourcing**: Sources images and video footage from the internet, connecting with the web and Pexels API as necessary.
50
+
51
+ - ๐Ÿง  **Memory and persistency**: Ensures long-term persistency of automated editing variables with TinyDB.
52
+
53
+ ## ๐Ÿš€ Quick Start: Run ShortGPT on Google Colab (https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing)
54
+
55
+ If you prefer not to install the prerequisites on your local system, you can use the Google Colab notebook. This option is free and requires no installation setup.
56
+
57
+ 1. Click on the link to the Google Colab notebook: [https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing](https://colab.research.google.com/drive/1_2UKdpF6lqxCqWaAcZb3rwMVQqtbisdE?usp=sharing)
58
+
59
+ 2. Once you're in the notebook, simply run the cells in order from top to bottom. You can do this by clicking on each cell and pressing the 'Play' button, or by using the keyboard . Enjoy using ShortGPT!
60
+
61
+ # Instructions for running shortGPT
62
+ This guide provides step-by-step instructions for installing ImageMagick and FFmpeg on your system, which are both required to do automated editing. Once installed, you can proceed to run `runShortGPT.py` successfully.
63
+
64
+ ## Prerequisites
65
+ Before you begin, ensure that you have the following prerequisites installed on your system:
66
+ - Python 3.x
67
+ - Pip (Python package installer)
68
+
69
+ ## Installation Steps
70
+ Follow the instructions below to install ImageMagick, FFmpeg, and clone the shortGPT repository:
71
+
72
+ ### Step 1: Install ImageMagick
73
+ 1. For `Windows` download the installer from the official ImageMagick website and follow the installation instructions.
74
+
75
+ [https://imagemagick.org/script/download.php](https://imagemagick.org/script/download.php)
76
+
77
+ 2. For Ubuntu/Debian-based systems, use the command:
78
+ ```
79
+ sudo apt-get install imagemagick
80
+ ```
81
+ Then run the following command to fix a moviepy Imagemagick policy.xml incompatibility problem:
82
+ ```
83
+ !sed -i '/<policy domain="path" rights="none" pattern="@\*"/d' /etc/ImageMagick-6/policy.xml
84
+ ```
85
+ 4. For macOS using Homebrew, use the command:
86
+ ```
87
+ brew install imagemagick
88
+ ```
89
+ 2. Verify the installation by running the following command:
90
+ ```
91
+ convert --version
92
+ ```
93
+ You should see the ImageMagick version information if the installation was successful.
94
+
95
+ ### Step 2: Install FFmpeg (REQUIRED FOR SHORTGPT TO WORK)
96
+ 1. For `Windows`Download the FFmpeg binaries from this Windows Installer (It will download ffmpeg, ffprobe and add it to your path).
97
+
98
+ [https://github.com/icedterminal/ffmpeg-installer/releases/tag/6.0.0.20230306](https://github.com/icedterminal/ffmpeg-installer/releases/tag/6.0.0.20230306)
99
+
100
+ 2. For macOS using Homebrew, use the command:
101
+ ```
102
+ brew install ffmpeg
103
+ ```
104
+ For Ubuntu/Debian-based systems, use the command:
105
+ ```
106
+ sudo apt-get install ffmpeg
107
+ ```
108
+ 2. Verify the installation by running the following command:
109
+ ```
110
+ ffmpeg -version
111
+ ```
112
+ You should see the FFmpeg version information if the installation was successful.
113
+
114
+ ### Step 3: Clone the shortGPT Repository
115
+
116
+ 1. Open a terminal or command prompt.
117
+ 2. Execute the following command to clone the shortGPT repository:
118
+ ```
119
+ git clone https://github.com/rayventura/shortgpt.git
120
+ ```
121
+
122
+ ### Step 4: Install Python Dependencies
123
+
124
+ 1. Open a terminal or command prompt.
125
+ 2. Navigate to the directory where `runShortGPT.py` is located (the cloned repo).
126
+ 3. Execute the following command to install the required Python dependencies:
127
+ ```
128
+ pip install -r requirements.txt
129
+ ```
130
+
131
+ This command will install the necessary packages specified in the `requirements.txt` file.
132
+
133
+ ## Running runShortGPT.py Web Interface
134
+
135
+ Once you have successfully installed ImageMagick, FFmpeg, and the Python dependencies, you can run `runShortGPT.py` by following these steps:
136
+
137
+ 1. Open a terminal or command prompt.
138
+ 2. Navigate to the directory where `runShortGPT.py` is located (the cloned repo).
139
+ 3. Execute the following command to run the script:
140
+ ```
141
+ python runShortGPT.py
142
+ ```
143
+ 4. After running the script, a Gradio interface should open at your local host on port 31415 (http://localhost:31415).
144
+
145
+ ## Putting API Keys
146
+ The ShortGPT UI needs you to input at least OpenAI and ElevenLabs api keys for running short automations. For video automations, you will also need to add a Pexels API.
147
+
148
+ Follow these steps to add your OpenAI and ElevenLabs API keys:
149
+
150
+ 1. Open [http://localhost:31415/?__theme=light](http://localhost:31415/?__theme=light) from a web browser.
151
+ 2. Click on the `config` tab located at the left side bar of the user interface.
152
+ 3. Add your `OPENAI API KEY` and `ELEVENLABS API KEY` in the corresponding input fields.
153
+ 4. Click `Save` to save your API keys.
154
+
155
+ That's it! You have successfully set up your API keys and can now utilize the functionality of ShortGPT in the Gradio interface.
156
+
157
+ ## Framework overview
158
+
159
+ - ๐ŸŽฌ The `ContentShortEngine` is designed for creating shorts, handling tasks from script generation to final rendering, including adding YouTube metadata.
160
+
161
+ - ๐ŸŽฅ The `ContentVideoEngine` is ideal for longer videos, taking care of tasks like generating audio, automatically sourcing background video footage, timing captions, and preparing background assets.
162
+
163
+ - ๐ŸŽž๏ธ The automated `EditingEngine`, using Editing Markup Language and JSON, breaks down the editing process into manageable and customizable blocks, comprehensible to Large Language Models.
164
+
165
+ ๐Ÿ’ก ShortGPT offers customization options to suit your needs, from language selection to watermark addition.
166
+
167
+ ๐Ÿ”ง As a framework, ShortGPT is adaptable and flexible, offering the potential for efficient, creative content creation.
168
+
169
+ More documentation incomming, please be patient.
170
+
171
+
172
+ ## Technologies Used
173
+
174
+ ShortGPT utilizes the following technologies to power its functionality:
175
+
176
+ - **Moviepy**: Moviepy is used for video editing, allowing ShortGPT to make video editing and rendering
177
+
178
+ - **Openai**: Openai is used for automating the entire process, including generating scripts and prompts for LLM automated editing processes.
179
+
180
+ - **ElevenLabs**: ElevenLabs is used for voice synthesis, supporting multiple languages for voiceover creation.
181
+
182
+ - **Pexels**: Pexels is used for sourcing background footage, allowing ShortGPT to connect with the web and access a wide range of images and videos.
183
+
184
+ - **Bing Image**: Bing Image is used for sourcing images, providing a comprehensive database for ShortGPT to retrieve relevant visuals.
185
+
186
+ These technologies work together to provide a seamless and efficient experience in automating video and short content creation with AI.
187
+
188
+ ## ๐Ÿ’ Contributing
189
+
190
+ As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it would be in the form of a new feature, improved infrastructure, or better documentation.
191
+
192
+ ## ๐Ÿ”— Get in touch on Twitter ๐Ÿฆ
193
+
194
+ Keep up with the latest happenings, announcements, and insights about Short-GPT by checking out our Twitter accounts. Spark a conversation with our developer and the AI's own account for fascinating dialogues, latest news about the project, and more.
195
+
196
+ - **Developer**: Stay updated [@RayVentura](https://twitter.com/RayVenturaHQ). Deep-dive into behind-the-scenes, project news, and related topics from the person behind ShortGPT.
197
+
198
+ We're eager to interact with you and listen to your feedback, concepts, and experiences with Short-GPT. Come on board on Twitter and let's navigate the future of AI as a team! ๐Ÿ’ก๐Ÿค–
199
+ <p align="center">
200
+ <a href="https://star-history.com/#RayVentura/ShortGPT&Date">
201
+ <img src="https://api.star-history.com/svg?repos=RayVentura/ShortGPT&type=Date" alt="Star History Chart">
202
+ </a>
203
+ </p>