From 992cccc570e925ff2c04efea77f7e6eb5eebf9a0 Mon Sep 17 00:00:00 2001
From: Paillat
Date: Thu, 29 Feb 2024 00:34:33 +0100
Subject: [PATCH 1/4] Update README.md
---
README.md | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 123 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index b6c4402..0809f84 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,124 @@
-# ViralFactory
-## Generate unlimited content with AI
+
+
+
Viral Factory
-[](https://app.fossa.com/api/projects/git%2Bgithub.com%2FPaillat-dev%2Fviralfactory.svg?type=large)
+
+ Viral Factory is a highly modular gradio app that automatesstrong> the production of various forms of social media content. Thanks to it's complex engines system it allows you to customize it's process in detail.
+
+
+ Report Bug
+ .
+ Request Feature
+
+
+
+  
+
+## Table Of Contents
+
+* [About the Project](#about-the-project)
+* [Built With](#built-with)
+* [Getting Started](#getting-started)
+ * [Prerequisites](#prerequisites)
+ * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Authors](#authors)
+* [Acknowledgements](#acknowledgements)
+
+## About The Project
+
+
+
+Viral Factory is a **highly modular** [gradio](https://github.com/gradio-app/gradio) app that **automates** the production of various forms of **social media content** with custom pipelines to allow for custom usage.
+
+It can handle, **notably:**
+- Writing scripts
+- Text to Speech
+- Assets retrieval
+- Video Backgrounds
+- Audio Backgrounds
+- Upload to TikTok and YouTube
+
+
+
+## Built With
+
+Thiw project was built with ❤️ and with
+
+* [Gradio](https://github.com/gradio-app/gradio)
+* [🐸TTS](https://github.com/coqui-ai/TTS)
+* [moviepy](https://github.com/Zulko/moviepy)
+* [whisper-timestamped](https://github.com/linto-ai/whisper-timestamped)
+
+## Getting Started
+
+
+### Prerequisites
+
+Currently, an Nvidia gpu with at least around 10 GB of vram is required for this project to work in optimal conditions, and at minima 20 GB of free disk storage.
+You will need as well to have the following software installed (click on them to install):
+- [CUDA 11.8](https://developer.nvidia.com/cuda-11-8-0-download-archive)
+- [ffmpeg](https://ffmpeg.org/download.html)
+- [imagemagick](https://imagemagick.org/script/download.php)
+- [git](https://git-scm.com/downloads)
+- [Python 3.10](https://www.python.org/downloads/release/python-31011/)
+
+### Installation
+
+Once the above requirements are installed, reboot your computer. Then, open a terminal window, navigate to where you want to install the project and run, one line at a time the following:
+```bash
+git clone https://github.com/Paillat-dev/viralfactory
+cd viralfactory
+py -3.10 -m venv venv
+pip install -r requirement.txt
+```
+This might take some time, you should not worry about it seeming stuck.
+
+## Usage
+
+You can launch the webapp with:
+```bash
+.\venv\Scripts\activate # Windows
+source venv/bin/activate # MacOS (unsure) & Linux
+```
+
+Watch the video below to learn more on how to use.
+
+*coming soon*
+
+## Roadmap
+
+See the [open issues](https://github.com/Paillat-dev/viralfactory/issues) for a list of proposed features (and known issues).
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/Paillat-dev/viralfactory/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
+* Please make sure you check your spelling and grammar.
+* Create individual PR for each suggestion.
+* Please also read through the [Code Of Conduct](https://github.com/Paillat-dev/viralfactory/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
+
+### Creating A Pull Request
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m '✨feat(Engines.LLMEngine) Add mistral local engine'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+Distributed under the AGPL-3.0 license. See [LICENSE](/LICENSE) for more information
+
+## Authors
+
+* **Paillat-dev** - ** - [Paillat-dev](https://github.com/Paillat-dev/) - *Main author*
+
+## Acknowledgements
+
+* [ShaanCoding](https://github.com/ShaanCoding/)
+* [Othneil Drew](https://github.com/othneildrew/Best-README-Template)
+* [ImgShields](https://shields.io/)
From 1a970be2e1227a98ce7633258b6c3b9745eb3b04 Mon Sep 17 00:00:00 2001
From: Paillat
Date: Thu, 29 Feb 2024 00:36:36 +0100
Subject: [PATCH 2/4] Update README.md
---
README.md | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 0809f84..a9c7c55 100644
--- a/README.md
+++ b/README.md
@@ -96,10 +96,9 @@ See the [open issues](https://github.com/Paillat-dev/viralfactory/issues) for a
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
-* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/Paillat-dev/viralfactory/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
-* Please make sure you check your spelling and grammar.
+* If you have suggestions, feel free to [open an issue](https://github.com/Paillat-dev/viralfactory/issues/new) to discuss it.
+* Please make sure you check your **spelling and grammar**.
* Create individual PR for each suggestion.
-* Please also read through the [Code Of Conduct](https://github.com/Paillat-dev/viralfactory/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
### Creating A Pull Request
From b734d7d0afd65cdb5ef71f07b1a317345d1fd8c3 Mon Sep 17 00:00:00 2001
From: Paillat
Date: Thu, 29 Feb 2024 01:01:23 +0100
Subject: [PATCH 3/4] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a9c7c55..003a964 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
Viral Factory
- Viral Factory is a highly modular gradio app that automatesstrong> the production of various forms of social media content. Thanks to it's complex engines system it allows you to customize it's process in detail.
+ Viral Factory is a highly modular gradio app that automates the production of various forms of social media content. Thanks to it's complex engines system it allows you to customize it's process in detail.
Report Bug
From a3d1ded8dafd09440d0784a460be97f7d1852f78 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 29 Feb 2024 05:37:42 +0000
Subject: [PATCH 4/4] Update dependency openai to v1.13.3
---
requirements.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.txt b/requirements.txt
index e249275..0ff7183 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,7 +5,7 @@ Google_Images_Search==1.4.6
gradio==4.19.0
httplib2==0.22.0
moviepy==1.0.3
-openai==1.12.0
+openai==1.13.3
orjson==3.9.15
protobuf==4.25.3
python-dotenv==1.0.1