Merge pull request #1 from scraperapi/dev

Adds scraperapi integration

Author: chaseleantj

.gitignore

@@ -1 +1,4 @@
+.env
+.vscode
 __pycache__
+.pytest_cache

README.md

@@ -1,45 +1,48 @@
-# langchain-scraperapi
+# Langchain ScraperAPI Integration
 
-This package contains the LangChain integration with ScraperAPI
+This package contains the LangChain integration with ScraperAPI.
 
 ## Installation
 
 ```bash
 pip install -U langchain-scraperapi
 ```
 
-And you should configure credentials by setting the following environment variables:
+And you should configure credentials by setting the environment variable `SCRAPERAPI_API_KEY`.
 
-* TODO: fill this out
+## Tools
 
-## Chat Models
+### ScraperAPITool
 
-`ChatScraperAPI` class exposes chat models from ScraperAPI.
+`ScraperAPITool` exposes the web scraping tool from ScraperAPI.
 
 ```python
-from langchain_scraperapi import ChatScraperAPI
+from langchain_scraperapi import ScraperAPITool
 
-llm = ChatScraperAPI()
-llm.invoke("Sing a ballad of LangChain.")
+tool = ScraperAPITool()
+tool.invoke("url: http://example.com", "output_format": "markdown")
 ```
 
-## Embeddings
+### ScraperAPIGoogleSearchTool
 
-`ScraperAPIEmbeddings` class exposes embeddings from ScraperAPI.
+`ScraperAPIGoogleSearchTool` allows the scraping of Google search results in `json` or `csv` format.
 
 ```python
-from langchain_scraperapi import ScraperAPIEmbeddings
+from langchain_scraperapi import ScraperAPIGoogleSearchTool
 
-embeddings = ScraperAPIEmbeddings()
-embeddings.embed_query("What is the meaning of life?")
+tool = ScraperAPIGoogleSearchTool()
+tool.invoke("query": "What is ScraperAPI?")
 ```
 
-## LLMs
-`ScraperAPILLM` class exposes LLMs from ScraperAPI.
+### ScraperAPIAmazonSearchTool
+
+`ScraperAPIAmazonSearchTool` allows the scraping of Amazon search results in `json` or `csv` format.
 
 ```python
-from langchain_scraperapi import ScraperAPILLM
+from langchain_scraperapi import ScraperAPIAmazonSearchTool
 
-llm = ScraperAPILLM()
-llm.invoke("The meaning of life is")
+tool = ScraperAPIAmazonSearchTool()
+tool.invoke("query": "office chairs", "output_format": "csv")
 ```
+
+For a full list of parameters and more information, refer to the ScraperAPI Python docs: https://docs.scraperapi.com/python/making-requests/structured-data-collection-method