Home

Awesome

πŸ•·οΈ ScrapeGraphAI: You Only Scrape Once

English | δΈ­ζ–‡ | ζ—₯本θͺž | ν•œκ΅­μ–΄ | Русский

Downloads linting: pylint Pylint CodeQL License: MIT

ScrapeGraphAI is a web scraping python library that uses LLM and direct graph logic to create scraping pipelines for websites and local documents (XML, HTML, JSON, Markdown, etc.).

Just say which information you want to extract and the library will do it for you!

<p align="center"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/sgai-hero.png" alt="ScrapeGraphAI Hero" style="width: 100%;"> </p>

πŸš€ Quick install

The reference page for Scrapegraph-ai is available on the official page of PyPI: pypi.

pip install scrapegraphai

playwright install

Note: it is recommended to install the library in a virtual environment to avoid conflicts with other libraries 🐱

<details> <summary><b>Optional Dependencies</b></summary> Additional dependecies can be added while installing the library: </details>

πŸ’» Usage

There are multiple standard scraping pipelines that can be used to extract information from a website (or local file).

The most common one is the SmartScraperGraph, which extracts information from a single page given a user prompt and a source URL.

import json
from scrapegraphai.graphs import SmartScraperGraph

# Define the configuration for the scraping pipeline
graph_config = {
    "llm": {
        "api_key": "YOUR_OPENAI_APIKEY",
        "model": "openai/gpt-4o-mini",
    },
    "verbose": True,
    "headless": False,
}

# Create the SmartScraperGraph instance
smart_scraper_graph = SmartScraperGraph(
    prompt="Find some information about what does the company do, the name and a contact email.",
    source="https://scrapegraphai.com/",
    config=graph_config
)

# Run the pipeline
result = smart_scraper_graph.run()
print(json.dumps(result, indent=4))

The output will be a dictionary like the following:

{
    "company": "ScrapeGraphAI",
    "name": "ScrapeGraphAI Extracting content from websites and local documents using LLM",
    "contact_email": "contact@scrapegraphai.com"
}

There are other pipelines that can be used to extract information from multiple pages, generate Python scripts, or even generate audio files.

Pipeline NameDescription
SmartScraperGraphSingle-page scraper that only needs a user prompt and an input source.
SearchGraphMulti-page scraper that extracts information from the top n search results of a search engine.
SpeechGraphSingle-page scraper that extracts information from a website and generates an audio file.
ScriptCreatorGraphSingle-page scraper that extracts information from a website and generates a Python script.
SmartScraperMultiGraphMulti-page scraper that extracts information from multiple pages given a single prompt and a list of sources.
ScriptCreatorMultiGraphMulti-page scraper that generates a Python script for extracting information from multiple pages and sources.

For each of these graphs there is the multi version. It allows to make calls of the LLM in parallel.

It is possible to use different LLM through APIs, such as OpenAI, Groq, Azure and Gemini, or local models using Ollama.

Remember to have Ollama installed and download the models using the ollama pull command, if you want to use local models.

πŸ” Demo

Official streamlit demo:

My Skills

Try it directly on the web using Google Colab:

Open In Colab

πŸ“– Documentation

The documentation for ScrapeGraphAI can be found here.

Check out also the Docusaurus here.

πŸ† Sponsors

<div style="text-align: center;"> <a href="https://2ly.link/1zaXG"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/browserbase_logo.png" alt="Browserbase" style="width: 10%;"> </a> <a href="https://2ly.link/1zNiz"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/serp_api_logo.png" alt="SerpAPI" style="width: 10%;"> </a> <a href="https://2ly.link/1zNj1"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/transparent_stat.png" alt="Stats" style="width: 15%;"> </a> <a href="https://scrape.do"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/scrapedo.png" alt="Stats" style="width: 11%;"> </a> </div>

🀝 Contributing

Feel free to contribute and join our Discord server to discuss with us improvements and give us suggestions!

Please see the contributing guidelines.

My Skills My Skills My Skills

πŸ“ˆ Telemetry

We collect anonymous usage metrics to enhance our package's quality and user experience. The data helps us prioritize improvements and ensure compatibility. If you wish to opt-out, set the environment variable SCRAPEGRAPHAI_TELEMETRY_ENABLED=false. For more information, please refer to the documentation here.

❀️ Contributors

Contributors

πŸŽ“ Citations

If you have used our library for research purposes please quote us with the following reference:

  @misc{scrapegraph-ai,
    author = {Marco Perini, Lorenzo Padoan, Marco Vinciguerra},
    title = {Scrapegraph-ai},
    year = {2024},
    url = {https://github.com/VinciGit00/Scrapegraph-ai},
    note = {A Python library for scraping leveraging large language models}
  }

Authors

<p align="center"> <img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/logo_authors.png" alt="Authors_logos"> </p>
Contact Info
Marco VinciguerraLinkedin Badge
Marco PeriniLinkedin Badge
Lorenzo PadoanLinkedin Badge

πŸ“œ License

ScrapeGraphAI is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgements