feat: refctoring of the folder

Author: VinciGit00

scrapegraph-py/examples/scrape_example.py renamed to scrapegraph-py/examples/smart_scraper_example.py

@@ -1,5 +1,5 @@
 import os
-from scrapegraph_py import ScrapeGraphClient, scrape
+from scrapegraph_py import ScrapeGraphClient, smart_scraper
 from dotenv import load_dotenv
 
 load_dotenv()
@@ -9,5 +9,5 @@
 url = "https://scrapegraphai.com/"
 prompt = "What does the company do?"
 
-result = scrape(client, url, prompt)
+result = smart_scraper(client, url, prompt)
 print(result)

scrapegraph-py/examples/scrape_schema_example.py renamed to scrapegraph-py/examples/smart_scraper_schema_example.py

@@ -1,6 +1,6 @@
 import os
 from pydantic import BaseModel, Field
-from scrapegraph_py import ScrapeGraphClient, scrape
+from scrapegraph_py import ScrapeGraphClient, smart_scraper
 from dotenv import load_dotenv
 
 load_dotenv()
@@ -19,5 +19,5 @@ class CompanyInfoSchema(BaseModel):
 prompt = "What does the company do?"
 
 # Call the scrape function with the schema
-result = scrape(client=client, url=url, prompt=prompt, schema=CompanyInfoSchema)
+result = smart_scraper(client=client, url=url, prompt=prompt, schema=CompanyInfoSchema)
 print(result)

scrapegraph-py/scrapegraph_py/__init__.py

@@ -1,4 +1,15 @@
+"""
+ScrapeGraph Package
+
+This package provides tools for web scraping and data extraction, including:
+
+- ScrapeGraphClient: A client for interacting with the ScrapeGraph API.
+- smart_scraper: A utility for intelligent web scraping.
+- credits: Module for handling credits and usage.
+- feedback: Module for collecting and managing user feedback.
+"""
+
 from .client import ScrapeGraphClient
-from .scrape import scrape
+from .smart_scraper import smart_scraper
 from .credits import credits
-from .feedback import feedback
+from .feedback import feedback

scrapegraph-py/scrapegraph_py/scrape.py renamed to scrapegraph-py/scrapegraph_py/smart_scraper.py

@@ -16,9 +16,9 @@
 from .client import ScrapeGraphClient
 from .exceptions import APIError, raise_for_status_code
 
-def scrape(client: ScrapeGraphClient, url: str, prompt: str, 
+def smart_scraper(client: ScrapeGraphClient, url: str, prompt: str, 
            schema: Optional[BaseModel] = None) -> str:
-    """Scrape and extract structured data from a webpage using ScrapeGraph AI.
+    """smart_scraper and extract structured data from a webpage using ScrapeGraph AI.
 
     Args:
         client (ScrapeGraphClient): Initialized ScrapeGraph client