KeepYourMouthShut - Acid Reflux for your Ears!

[Please consider sponsoring this project to help keep it alive!]

KeepYourMouthShut is an AI-assisted open-source app that provides a 360-degree podcast solution 🎙️ It has a developer-first approach for creating entire episodes of podcasts without requiring any expensive equpment or setup. The app takes a number of input from the end-user and based on that generates a script and an audio voice-over file based on that script.

Table of Content

• 🚀 Installation
• ⚠️ Deployment
• 🛠️ Built With
• 🎸 Music
• 🚸 Contributing
• 🪫 Versioning
• 🏅 Acknowledgement
• 🕹️ License
• 📟 Citation

🚀 Installation

For local installation, clone the repository and run the following commands:

1. Install FFMPEG
2. Create a free account on llmOS and get an API key
3. Insert the API key in the .env file. A sample .env file is given.
4. Run pip install -r app/requirements.txt
5. Run flask --app app/keepyourmouthshut.py run

This will start the Flask app on port 5000 within a development environment. You can view the app in your browser at http://127.0.0.1:5000.

⚠️ Deployment

This app can be deployed on AWS. The following official tutorial from AWS will show you how to serve a Flask app on AWS:

https://aws.amazon.com/tutorials/serve-a-flask-app/

If you want to deploy this app on AWS Lambda as a Serverless function, you can use Zappa.

🛠️ Built With

• Python
• llmOS
• edge-tts
• ElevenLabs text2speech
• OpenAI API
• Pixabay

🎸 Music

• Whistle Vibes - Music by Sergio Prosvirini from Pixabay
• Scandinavianz Thessaloniki - Music by Oliver Moilanen from Pixabay
• Lofi Chill (medium version) - Music by Bohdan Kuzmin from Pixabay
• Bolero - Music by Oleksii Kaplunskyi from Pixabay

🚸 Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

🪫 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

🏅 Acknowledgement

1. Adam Tal - https://github.com/AdmTal
2. rany2 - https://github.com/rany2

🕹️ License

This project is licensed under the GPL-3.0 license, see the LICENSE.md file for details

Star History

📟 Citation

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Bhattacharjee"
  given-names: "Rajtilak"
  orcid: "https://orcid.org/0009-0008-2465-0266"
title: "keepyourmouthshut"
version: 0.0.1
doi: 10.5281/zenodo.10199470
date-released: 2023-11-23
url: "https://github.com/rajtilakjee/keepyourmouthshut"