Skip to main content

A semantic web scraping and summarization toolkit.

Project description

vibescraper

vibescraper is a Python utility that generates an AI summary of web results based on a search query.


How it works

  • Web Search: Searched the web using search engine API.
  • Semantic Chunking: Extracts html from each url in the search results, then divides the html page content into meaningful chunks.
  • Embedding Generation: Generate vector embeddings for each chunk using openai embedding models.
  • Similarity Search: Find the most relevant content chunks for a given search query.
  • AI Summarization: Generates concise summaries of relevant content, then combines all summaries into a combined summary.
  • JSON Export: Saves results and summaries as JSON files for easy inspection or downstream use.

Installation

Install via pip (from PyPI):

pip install vibescraper

Or install locally with Poetry:

poetry install

NOTE: You need either a Beave or Google search API key to use this, as well as an open AI API key.

to import the keys into config.py after installing run: check-api-keys

in your python project env.


Requirements

  • Python 3.12+
  • OpenAI API key (for embedding and summarization)
  • Other dependencies: numpy, requests, beautifulsoup4, pandas, sqlalchemy, openai, tiktoken, google-api-python-client, html5lib

Usage

  • Install the package into your python project, then import the vibe_search function
from vibescraper import vibe_search

ai_summary = await vibe_search(query='What is the state of the software development job market in 2025?', domain_count=10, model='gpt-4o')

Environment Variables

You must set your OpenAI API key (and either a Google or Brave yea keys) as environment variables


License

MIT License


Contributing

Pull requests and issues are welcome!


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibescraper-0.1.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibescraper-0.1.2-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file vibescraper-0.1.2.tar.gz.

File metadata

  • Download URL: vibescraper-0.1.2.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.3 Linux/6.8.0-52-generic

File hashes

Hashes for vibescraper-0.1.2.tar.gz
Algorithm Hash digest
SHA256 708c2ab055ad02234a4799099413e653ef76146063734973c6977c59d15423dd
MD5 b4428bbc321316a844f48daf1d828b22
BLAKE2b-256 6b4544f7598ccf870004c3541501f83e0c4309b2d63330470a7ea05e18e02d8b

See more details on using hashes here.

File details

Details for the file vibescraper-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vibescraper-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.3 Linux/6.8.0-52-generic

File hashes

Hashes for vibescraper-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 37c29e0364c44b3846693b008e528fabf9d0837792309a1cb694f5a87617e039
MD5 0103262ee8a5efc0516db595e27d4525
BLAKE2b-256 2acb9ed3297cf29a35e4f31ffb1ad388822c43d799c508c05433cbb11d71e446

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page