| .github | ||
| .streamlit | ||
| docs | ||
| examples | ||
| scrapegraphai | ||
| tests/utils | ||
| .gitattributes | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| commit_and_push.sh | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| readthedocs.yml | ||
| requirements-dev.txt | ||
| requirements.txt | ||
| SECURITY.md | ||
🕷️ 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!
🚀 Quick install
The reference page for Scrapegraph-ai is avaible on the official page of pypy: pypi.
pip install scrapegraphai
🔍 Demo
Official streamlit demo:
Is it possible to try also the colab version
Try out ScrapeGraphAI in your browser:
📖 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!
You can also follow all the updates on linkedin!
Contributors
Authors
| Contact Info | |
|---|---|
| Marco Vinciguerra |  |
| Marco Perini | |
| Lorenzo Padoan | |
📜 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.