https://github.com/timooo-thy/text-summariser
This streamlit app allows you to query any tech questions and generate an Instagram post.
https://github.com/timooo-thy/text-summariser
Last synced: about 1 year ago
JSON representation
This streamlit app allows you to query any tech questions and generate an Instagram post.
- Host: GitHub
- URL: https://github.com/timooo-thy/text-summariser
- Owner: timooo-thy
- Created: 2023-08-31T18:14:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T17:35:06.000Z (almost 3 years ago)
- Last Synced: 2025-05-20T11:14:29.443Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Text Summariser and Instagram Post Generator
This application fetches relevant articles based on a query, summarises the content, and then creates a compelling Instagram post based on the summarised content.
This idea was inspired by AIJason!
## Getting Started
Follow these steps to set up and run the Streamlit app on your local machine.
## Prerequisites
- Python (>=3.9)
- pip (Python package manager)
## Installation
1. Clone this repository to your local machine:
```bash
git clone https://github.com/timooo-thy/text-summariser.git
cd text-summariser
2. Create a virtual environment (recommended):
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
3. Install the required packages:
```bash
pip install -r requirements.txt
## Setup Environment Variables
1. Create a `.env` file in the root directory of the project.
2. Add your API tokens information to the `.env` file in the following format:
SERP_API_KEY=your_serp_api_key
OPENAI_API_KEY=your_openai_api_key
3. Make sure to include `.env` in your `.gitignore` file to keep your sensitive information secure.
## Running the App
1. Open a terminal and navigate to the project directory.
2. Activate the virtual environment if you created one:
```bash
source venv/bin/activate # On Windows: venv\Scripts\activate
3. Run the Streamlit app:
```bash
streamlit run app.py
4. The app should open in your default web browser.
## Deploying to Production
For deploying the app to a production environment, consider deploying from Streamlit. Be sure to adjust configurations and follow deployment instructions for your chosen platform.
## Author
©Timothy Lee