Skip to main content

A web scraping library based on LangChain which uses LLM and direct graph logic to create scraping pipelines.

Project description

🕷️ ScrapeGraphAI: You Only Scrape Once

ScrapeGraphAI is a web scraping python library based on LangChain which uses LLM and direct graph logic to create scraping pipelines. Just say which information you want to extract and the library will do it for you!

Scrapegraph-ai Logo

🚀 Quick install

The reference page for Scrapegraph-ai is avaible on the official page of pypy: pypi.

pip install scrapegraphai

🔍 Demo

Official streamlit demo:

My Skills

Is it possible to try also the colab version

Open In Colab

Try out ScrapeGraphAI in your browser:

Open in GitHub Codespaces

📖 Documentation

The documentation for ScrapeGraphAI can be found here. Behind this there is also the docusaurus documentation here).

Setup the api keys

Follow the procedure on the following link to setup your OpenAI API key: link.

💻 Usage

Case 1: Extracting information using a prompt

You can use the SmartScraper class to extract information from a website using a prompt.

The SmartScraper class is a direct graph implementation that uses the most common nodes present in a web scraping pipeline. For more information, please see the documentation.

from scrapegraphai.graphs import SmartScraper

OPENAI_API_KEY = "YOUR_API_KEY"

llm_config = {
    "api_key": OPENAI_API_KEY,
    "model_name": "gpt-3.5-turbo",
}

smart_scraper = SmartScraper("List me all the titles and project descriptions",
                             "https://perinim.github.io/projects/", llm_config)

answer = smart_scraper.run()
print(answer)

The output will be a dictionary with the extracted information, for example:

{
    'titles': [
        'Rotary Pendulum RL'
        ],
    'descriptions': [
        'Open Source project aimed at controlling a real life rotary pendulum using RL algorithms'
        ]
}

🤝 Contributing

Scrapegraph-ai is MIT LICENSED.

Contributions are welcome! Please check out the todos below, and feel free to open a pull request.

For more information, please see the contributing guidelines.

Join our Discord server to discuss with us improvements and give us suggestions!

My Skills

You can also follow all the updates on linkedin!

My Skills

Contributors

Contributors

Authors

Authors Logos

Contact Info
Marco Vinciguerra Linkedin Badge
Marco Perini Linkedin Badge
Lorenzo Padoan Linkedin Badge

📜 License

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

Acknowledgements

  • We would like to thank all the contributors to the project and the open-source community for their support.
  • ScrapeGraphAI is meant to be used for data exploration and research purposes only. We are not responsible for any misuse of the library.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

scrapegraphai-0.0.5.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

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

scrapegraphai-0.0.5-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file scrapegraphai-0.0.5.tar.gz.

File metadata

  • Download URL: scrapegraphai-0.0.5.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.0 Windows/10

File hashes

Hashes for scrapegraphai-0.0.5.tar.gz
Algorithm Hash digest
SHA256 bef1cbc3d429c4fae2bc58bf61bca9f7723737657b7da3594bcd8e42ed64b622
MD5 1695939ef1253a62c5d8909ce6e7b65d
BLAKE2b-256 6520d4b0d8d914fff7f4e849ef7441df087a2b469bf40ddd30d531c8eb2d3064

See more details on using hashes here.

File details

Details for the file scrapegraphai-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: scrapegraphai-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.0 Windows/10

File hashes

Hashes for scrapegraphai-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b8c9386582336fc22f6b59884200a1e737d6ead554ff6c55fbc6068d2ccfc548
MD5 adf7f8a24614f940d18812ca03614ffe
BLAKE2b-256 fcf394a7353038edff528afb8502ac16feedfb41734b056e4dea84bef7a91f92

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