{"id":16129132,"url":"https://github.com/gautamxgambhir/Surfer","last_synced_at":"2025-03-18T14:30:28.130Z","repository":{"id":257806817,"uuid":"866185271","full_name":"gautamxgambhir/Surfer","owner":"gautamxgambhir","description":"Surfer: AI-Powered Website \u0026 Webpage Summarizer, is a Chrome extension designed to make web browsing faster and smarter by summarizing both website overviews and webpage content.  Whether you're doing in-depth research or just exploring a new site,  Surfer delivers concise summaries tailored to your needs.","archived":false,"fork":false,"pushed_at":"2024-11-30T18:13:02.000Z","size":119,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T09:44:05.725Z","etag":null,"topics":["ai","bart","chrome","css","extension","html","javascript","python","summarizer","together"],"latest_commit_sha":null,"homepage":"https://codeday.sh/surfer","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/gautamxgambhir.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":"2024-10-01T19:44:23.000Z","updated_at":"2024-11-30T18:13:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"75408e22-d3c9-4a2a-af9c-59aaf2359d71","html_url":"https://github.com/gautamxgambhir/Surfer","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"4180f57a025f86b2d5588496b3d9f40c309854b8"},"previous_names":["gautamxgambhir/surferr"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gautamxgambhir%2FSurfer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gautamxgambhir%2FSurfer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gautamxgambhir%2FSurfer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gautamxgambhir%2FSurfer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gautamxgambhir","download_url":"https://codeload.github.com/gautamxgambhir/Surfer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244239954,"owners_count":20421371,"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":["ai","bart","chrome","css","extension","html","javascript","python","summarizer","together"],"created_at":"2024-10-09T22:08:43.256Z","updated_at":"2025-03-18T14:30:28.124Z","avatar_url":"https://github.com/gautamxgambhir.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://i.ibb.co/gDjsWyg/Logo-Image.png\"\u003e\u003cbr\u003e\n\u003c/div\u003e\n\n-----------------\n\n# Surfer: AI-Powered Website \u0026 Webpage Summarizer\n\n![Python](https://img.shields.io/badge/python-3.12-blue)\n![Status](https://img.shields.io/badge/status-stable-brightgreen)\n![License](https://img.shields.io/badge/license-MIT-red)\n![Together-AI](https://img.shields.io/badge/Together%20AI-0f6fff)\n![BART](https://img.shields.io/badge/BART-8A2BE2)\n\n## What is it?\n\nSurfer is an AI-powered Chrome extension designed to make web browsing faster and smarter by summarizing both website overviews and webpage content. \nWhether you're doing in-depth research or just exploring a new site, \nSurfer delivers concise summaries tailored to your needs.\nWith Surfer, you can :\n - Get brief website summaries with just two lines of information.\n - Generate detailed webpage content summaries from articles, blogs, and more.\n\n## Main Features\n\nHere’s what makes **Surfer** essential :\n\n - **Website Information Summarization** : Receive a 2-line overview of any website for a quick glance at its purpose and content.\n - **Webpage Content Summarization** : Get comprehensive summaries of webpage content in a concise format. \n - **Real-time API Integration** : Surfer uses Together API and state-of-the-art models like BART for real-time summarization. \n\n## New Features\n\n- **Dark/Light Theme Toggle**: Surfer now includes a theme toggle button, allowing users to switch between light and dark modes for a comfortable browsing experience.\n- **Improved UI**: The UI has been enhanced for better and a more intuitive user experience. All elements, including the radio buttons and submit button, are now more user-friendly and visually appealing.\n- **Copy Summary**: Now, to make it easier for user to copy the generated summary, The user can simply click on the Summary to copy it to the clipoard.\n\n\n## Where to get it?\n\nThe extension is hosted on GitHub at : https://github.com/gautamxgambhir/surferr\n\n## Installation and Setup\n\n#### 1. Clone the repository :\n``` \ngit clone https://github.com/gautamxgambhir/Surferr.git \n```\n\n#### 2. Backend setup (Make sure the ```app.py``` server is running) :\n - Navigate to the project directory.\n - Install the required Python dependencies :\n    ```\n    pip install -r requirements.txt\n    ```\n - Make sure to enter your [Together AI](https://www.together.ai/) API key in ```api_key.txt```.\n\n - Start the Flask server :\n    ```\n    python app.py\n    ```\n#### 2. Load the extension in Chrome :\n - Go to **chrome://extensions/** in your browser.\n - Enable **Developer Mode** in the top-right corner.\n - Click **Load unpacked** and select the ```surfer``` directory.\n\n## Usage\nOnce installed, Surfer can summarize websites and webpage content directly from your Chrome browser :\n\n[Download Video Tutorial for Surfer Usage](https://drive.google.com/file/d/1YHjVjUMQOIx2S4loCVSnGJFuki_ft8k0/view?usp=sharing)\n\n#### 1. Open the Surfer Extension :\n - Click on the Surfer icon in your Chrome toolbar.\n#### 2. Select a Radio Button :\n - **Website Information** : Summarizes the website's core details.\n- **Webpage Content Summary** : Summarizes the visible content of the webpage you're currently on.\n#### 3. Submit Button :\n - Click **Submit** to get the summary of the webpage or website information directly in the extension's popup.\n\n## Dependencies\n - [**Flask** : Backend server for handling summarization requests.](https://flask.palletsprojects.com/en/3.0.x/)\n - [**Together API** : Real-time AI API for generating summaries.](https://www.together.ai/)\n - [**BART Model** : Summarization model for content extraction.](https://huggingface.co/docs/transformers/en/model_doc/bart)\n\n## Package\n\n#### Links\n - [PyPi](https://pypi.org/project/surferr/0.3/)\n - [Source code](https://github.com/gautamxgambhir/surferr)\n\n#### Package Installation\n    pip install surferr\n\n### Upgrade\n    pip install surferr --upgrade\n\n#### Package Features\n - Summarize any text\n - Extract text from a webpage\n - Summarize a webpage from a URl\n - Get website information summary\n\n##### Setup of Package\n\n```\nfrom surferr import Surfer, version\n\n# Make sure to provide your API key of Together AI\nAPI_KEY = \"YOUR_API_KEY\"\n\n# Create an instance of the Surfer class by providing the API key\nsurfer = Surfer(api_key=API_KEY)\n```\n\n##### Check Version\n\n```\n# Display the current version of the package\nprint(version())\n```\n\n##### Summarize a block of text\n\n```\ntext = \"\"\"\nYOUR_TEXT\n\"\"\"\n# Call the summarize_text method to generate summary\ntext_summary = surfer.summarize_text(text)\nprint(text_summary)\n```\n\n##### Extracting text content from a webpage\n\n```\n# Make sure to provide the URL\nurl = \"https://en.wikipedia.org/wiki/Artificial_intelligence\"\n\n# Call the extract_text_from_webpage method to fetch and extract text content from the webpage\nwebpage_text = surfer.extract_text_from_webpage(url)\nprint(webpage_text)\n```\n\n##### Summarizing a webpage's content\n\n```\n# Call the summarize_webpage method to generate a summary of the webpage's content\nwebpage_summary = surfer.summarize_webpage(url)\nprint(webpage_summary)\n```\n\n##### Getting Information about a website \n\n```\n# Use the website_info_summary method to get summary of the website\nwebsite_info = surfer.website_info_summary(url)\nprint(website_info)\n```\n\n## Contact\n\n- `Email` - ggambhir1919@gmail.com\n- `Instagram` - https://www.instagram.com/gautamxgambhir/\n- `Twitter` - https://www.twitter.com/gautamxgambhir/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgautamxgambhir%2FSurfer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgautamxgambhir%2FSurfer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgautamxgambhir%2FSurfer/lists"}