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

Try out ScrapeGraphAI in your browser:

Open In Colab

📖 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!

Join Discord Server

Contributors

Contributors

Authors

Authors Logos

📜 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.

Thanks to:

  • nicolapiazzalunga for having inspired us to the functions: scrapegraph/convert_to_json.py and scrapegraph/convert_to_csv.py

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.3.tar.gz (18.8 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.3-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scrapegraphai-0.0.3.tar.gz
Algorithm Hash digest
SHA256 8e162d42eaeb255eac0c10ae530c8b35fbc18d0b5a976d5b672127d270aa04c2
MD5 970b22f906250935294125f77b43228c
BLAKE2b-256 875661a0ba4f29b265d4312c5f3be4a02f29e1a80ca1dd26a6aa38cf49e2e350

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scrapegraphai-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b92bdb09e7b2c4b6c9a1c64ff578e98a08dfc80354b758fd8dc9267598795ba9
MD5 998ecac5bcc4145c4a04cf68f04d62fb
BLAKE2b-256 027061b65862876ccc2aa66222fe55781145d3e608a19b5ed86cebdf77148caf

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