{"id":23658248,"url":"https://github.com/timooo-thy/text-summariser","last_synced_at":"2025-06-23T13:33:25.808Z","repository":{"id":191911969,"uuid":"685662482","full_name":"timooo-thy/text-summariser","owner":"timooo-thy","description":"This streamlit app allows you to query any tech questions and generate an Instagram post.","archived":false,"fork":false,"pushed_at":"2023-09-04T17:35:06.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-20T11:14:29.443Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timooo-thy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-31T18:14:27.000Z","updated_at":"2023-08-31T18:29:41.000Z","dependencies_parsed_at":"2024-12-29T00:16:34.629Z","dependency_job_id":null,"html_url":"https://github.com/timooo-thy/text-summariser","commit_stats":null,"previous_names":["timooo-thy/text-summariser"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/timooo-thy/text-summariser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timooo-thy%2Ftext-summariser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timooo-thy%2Ftext-summariser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timooo-thy%2Ftext-summariser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timooo-thy%2Ftext-summariser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timooo-thy","download_url":"https://codeload.github.com/timooo-thy/text-summariser/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timooo-thy%2Ftext-summariser/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261487112,"owners_count":23166015,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-29T00:06:18.432Z","updated_at":"2025-06-23T13:33:20.789Z","avatar_url":"https://github.com/timooo-thy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Text Summariser and Instagram Post Generator\r\n\r\nThis application fetches relevant articles based on a query, summarises the content, and then creates a compelling Instagram post based on the summarised content.\r\n\r\nThis idea was inspired by AIJason!\r\n\r\n## Getting Started\r\n\r\nFollow these steps to set up and run the Streamlit app on your local machine.\r\n\r\n## Prerequisites\r\n\r\n- Python (\u003e=3.9)\r\n- pip (Python package manager)\r\n\r\n## Installation\r\n\r\n1. Clone this repository to your local machine:\r\n\r\n   ```bash\r\n   git clone https://github.com/timooo-thy/text-summariser.git\r\n   cd text-summariser\r\n\r\n2. Create a virtual environment (recommended):\r\n\r\n   ```bash\r\n   python -m venv venv\r\n   source venv/bin/activate # On Windows: venv\\Scripts\\activate\r\n   \r\n3. Install the required packages:\r\n\r\n   ```bash\r\n   pip install -r requirements.txt\r\n\r\n## Setup Environment Variables\r\n\r\n1. Create a `.env` file in the root directory of the project.\r\n\r\n2. Add your API tokens information to the `.env` file in the following format:\r\n   SERP_API_KEY=your_serp_api_key\r\n   OPENAI_API_KEY=your_openai_api_key\r\n\r\n3. Make sure to include `.env` in your `.gitignore` file to keep your sensitive information secure.\r\n\r\n## Running the App\r\n\r\n1. Open a terminal and navigate to the project directory.\r\n\r\n2. Activate the virtual environment if you created one:\r\n\r\n   ```bash\r\n   source venv/bin/activate # On Windows: venv\\Scripts\\activate\r\n   \r\n3. Run the Streamlit app:\r\n\r\n   ```bash\r\n   streamlit run app.py\r\n\r\n4. The app should open in your default web browser.\r\n\r\n## Deploying to Production\r\n\r\nFor deploying the app to a production environment, consider deploying from Streamlit. Be sure to adjust configurations and follow deployment instructions for your chosen platform.\r\n\r\n## Author\r\n\r\n©Timothy Lee\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimooo-thy%2Ftext-summariser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimooo-thy%2Ftext-summariser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimooo-thy%2Ftext-summariser/lists"}