https://github.com/smaranjitghose/aiemailgenerator
A minimalistic application to generate custom email templates built using Python and GPT-3
https://github.com/smaranjitghose/aiemailgenerator
docker email-generator gpt-3 open-source openai python python3 streamlit streamlit-lottie
Last synced: 3 months ago
JSON representation
A minimalistic application to generate custom email templates built using Python and GPT-3
- Host: GitHub
- URL: https://github.com/smaranjitghose/aiemailgenerator
- Owner: smaranjitghose
- License: agpl-3.0
- Created: 2022-12-26T12:37:57.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T03:01:27.000Z (over 2 years ago)
- Last Synced: 2025-01-26T04:12:45.743Z (4 months ago)
- Topics: docker, email-generator, gpt-3, open-source, openai, python, python3, streamlit, streamlit-lottie
- Language: Python
- Homepage:
- Size: 1.74 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## AI Email Generator
A minimalistic application to generate custom email templates built using Python and GPT-3
## Set-Up ⚒️
- Ensure you have the latest stable version of [Python](https://www.python.org/downloads/) in your system
- Open your terminal / command prompt.
- Clone the repository
```
git clone https://github.com/smaranjitghose/AIEmailGenerator.git
```
- Change the directory to the cloned project
```
cd AIEmailGenerator
```
- Create a virtual environment
```
python -m venv env
```
- Activate the virtual environment
- Windows
```
env/Scripts/Activate.ps1
```
- Linux/Mac
```
source env/bin/activate
```
- Check if the virtual environment in the concerned repository is used for python shell
```
which python
```
- Upgrage Pip Installer
```
python -m pip install --upgrade pip
```
- Install the dependencies
```
pip install -r requirements.txt
```
- Load the application
```
streamlit run .\Home.py
```
- If the app does not load by itself in your default browser, open a browser of your choice and navigate to `http://localhost:8501`
- To stop the application, press `CTRL + C` in your terminal
- To deactive the python environment, type in your terminal
```
deactivate
```
## Demo 👇
**v.0.0.1**
**v.0.0.1** (Sample Email)
## Note ✏️
- For Streamlit Sharing, mentioning versions of the modules in requirements throws error at times
## Future Work 🏗️
- [ ] Chrome Plugin
- [ ] Better Prompting
- [ ] Editable
- [ ] Sample Templats: 10
- [ ] Add to Email
## Deployment Options 🥊
- [Streamlit Cloud](https://streamlit.io/cloud)
- [HuggingFace Spaces](https://huggingface.co/docs/hub/spaces)
- [Fly](https://fly.io/)
- [Railway](https://railway.app/)
- [Render](https://render.com/)
- [Cyclic](https://app.cyclic.sh/#/)
- [Heroku](https://www.heroku.com/)
- [Digital Ocean](https://www.digitalocean.com/)
- Google App Engine
- Amazon EC2 Instance
- Azure App
(**Using Google Colab/Kaggle as temporary MVP server**)
- [pyngrok](https://pyngrok.readthedocs.io/en/latest/index.html)
- Step 1: Install pyngrok in Google Colab
```
! pip install pyngrok
```
- Step 2: Sign-up in [ngrok](https://ngrok.com/) and get Authentication Token
- Step 3: Authenticate
```python
from pyngrok import ngrok
ngrok.set_auth_token("xxx")
```
- Step 4: Load the Streamlit App at port 8051, create a tunnel for it and reveal the public URL for the tunnel
```python
!nohup streamlit run app.py --server.port 8051 &
url = ngrok.connect(8051).public_url
print(url)
```
- Step 5: Share URL with client
- [localtunnel](https://github.com/localtunnel/localtunnel)
- Step 1: Install localtunnel
```
npm install -g localtunnel
```
- Step 2
```
streamlit run Home.py & npx localtunnel --port 8501
```
- Step 3: Share URL with client
## Acknowledgements 🙏
- **Text to Text Generator Model**: [OpenAI GPT3](https://openai.com/blog/gpt-3-apps/)
- [Documentation](https://beta.openai.com/docs/)
- [Playground](https://beta.openai.com/playground)
- **Animations**: [LottieFiles](https://lottiefiles.com)