feat: refactoring of the folders

VinciGit00 · VinciGit00 · commit e613e2e07c95 · 2024-11-04T10:25:27.000+01:00
diff --git a/examples/credits_example.py b/examples/credits_example.py
@@ -5,7 +5,7 @@
 
 import os
 from dotenv import load_dotenv
-from scrapegraphaiapisdk.credits import credits
+from scrapegraph_py.credits import credits
 
 # Load environment variables from a .env file
 load_dotenv()
diff --git a/examples/feedback_example.py b/examples/feedback_example.py
@@ -1,7 +1,7 @@
 import os
 from dotenv import load_dotenv
-from scrapegraphaiapisdk.credits import status
-from scrapegraphaiapisdk.feedback import feedback
+from scrapegraph_py.credits import status
+from scrapegraph_py.feedback import feedback
 
 # Load environment variables from .env file
 load_dotenv()
diff --git a/examples/scrape_example.py b/examples/scrape_example.py
@@ -1,4 +1,4 @@
-from scrapegraphaiapisdk.scrape import scrape
+from scrapegraph_py.scrape import scrape
 from dotenv import load_dotenv  # Import load_dotenv
 import os  # Import os to access environment variables
 import json  # Import json for beautifying output
diff --git a/examples/scrape_schema_example.py b/examples/scrape_schema_example.py
@@ -1,5 +1,5 @@
-from pydantic import BaseModel
-from scrapegraphaiapisdk.scrape import scrape
+from pydantic import BaseModel, Field
+from scrapegraph_py.scrape import scrape
 from dotenv import load_dotenv
 import os
 
@@ -8,23 +8,16 @@
 
 # Define a Pydantic schema
 class CompanyInfoSchema(BaseModel):
-    company_name: str
-    description: str
-    main_products: list[str]
+    company_name: str = Field(description="The name of the company")
+    description: str = Field(description="A description of the company")
+    main_products: list[str] = Field(description="The main products of the company")
 
 # Example usage
 api_key = os.getenv("SCRAPEGRAPH_API_KEY")
 url = "https://scrapegraphai.com/"
 prompt = "What does the company do?"
 
-# Create an instance of the schema with initial values
-schema = CompanyInfoSchema(
-    company_name="Example Company",
-    description="An example company description.",
-    main_products=["Product1", "Product2"]
-)
-
 # Call the scrape function with the schema
-result = scrape(api_key=api_key, url=url, prompt=prompt, schema=schema)
+result = scrape(api_key=api_key, url=url, prompt=prompt, schema=CompanyInfoSchema)
 
 print(result)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "scrapegraphaiapisdk"
+name = "scrapegraph_py"
 version = "0.0.1"
 description = "library for extracting reference from documents"
 authors = [
diff --git a/requirements-dev.lock b/requirements-dev.lock
@@ -29,7 +29,7 @@ docutils==0.19
 exceptiongroup==1.2.2
     # via pytest
 furo==2024.5.6
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 idna==3.10
     # via requests
 imagesize==1.4.1
@@ -54,7 +54,7 @@ platformdirs==4.3.6
 pluggy==1.5.0
     # via pytest
 pydantic==2.9.2
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 pydantic-core==2.23.4
     # via pydantic
 pygments==2.18.0
@@ -65,17 +65,17 @@ pytest==8.0.0
     # via pytest-mock
 pytest-mock==3.14.0
 python-dotenv==1.0.1
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 requests==2.32.3
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
     # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.6
     # via beautifulsoup4
 sphinx==6.0.0
     # via furo
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
     # via sphinx-basic-ng
 sphinx-basic-ng==1.0.0b2
     # via furo
diff --git a/requirements.lock b/requirements.lock
@@ -17,13 +17,13 @@ charset-normalizer==3.4.0
 idna==3.10
     # via requests
 pydantic==2.9.2
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 pydantic-core==2.23.4
     # via pydantic
 python-dotenv==1.0.1
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 requests==2.32.3
-    # via scrapegraphaiapisdk
+    # via scrapegraph-py
 typing-extensions==4.12.2
     # via pydantic
     # via pydantic-core
diff --git a/scrapegraph_py/__init__.py b/scrapegraph_py/__init__.py
diff --git a/scrapegraph_py/credits.py b/scrapegraph_py/credits.py
diff --git a/scrapegraph_py/feedback.py b/scrapegraph_py/feedback.py
diff --git a/scrapegraph_py/scrape.py b/scrapegraph_py/scrape.py
diff --git a/tests/test_credits.py b/tests/test_credits.py
@@ -1,17 +1,17 @@
 import unittest
 from unittest.mock import patch
-from scrapegraphaiapisdk.credits import credits
+from scrapegraph_py.credits import credits
 
 class TestCredits(unittest.TestCase):
     
-    @patch('scrapegraphaiapisdk.credits.requests.get')
+    @patch('scrapegraph_py.credits.requests.get')
     def test_credits_success(self, mock_get):
         mock_get.return_value.status_code = 200
         mock_get.return_value.text = '{"credits": 100}'
         response = credits("test_api_key")
         self.assertEqual(response, '{"credits": 100}')
 
-    @patch('scrapegraphaiapisdk.credits.requests.get')
+    @patch('scrapegraph_py.credits.requests.get')
     def test_credits_http_error(self, mock_get):
         mock_get.side_effect = requests.exceptions.HTTPError
         response = credits("test_api_key")
diff --git a/tests/test_feedback.py b/tests/test_feedback.py
@@ -1,18 +1,18 @@
 import unittest
 from unittest.mock import patch
-from scrapegraphaiapisdk.feedback import feedback
+from scrapegraph_py.feedback import feedback
 import requests
 
 class TestFeedback(unittest.TestCase):
     
-    @patch('scrapegraphaiapisdk.feedback.requests.post')
+    @patch('scrapegraph_py.feedback.requests.post')
     def test_feedback_success(self, mock_post):
         mock_post.return_value.status_code = 200
         mock_post.return_value.text = '{"status": "success"}'
         response = feedback("test_api_key", "3fa85f64-5717-4562-b3fc-2c963f66afa6", 5, "Great service!")
         self.assertEqual(response, '{"status": "success"}')
 
-    @patch('scrapegraphaiapisdk.feedback.requests.post')
+    @patch('scrapegraph_py.feedback.requests.post')
     def test_feedback_http_error(self, mock_post):
         mock_post.side_effect = requests.exceptions.HTTPError
         response = feedback("test_api_key", "3fa85f64-5717-4562-b3fc-2c963f66afa6", 5, "Great service!")
diff --git a/tests/test_scrape.py b/tests/test_scrape.py
@@ -1,17 +1,17 @@
 import unittest
 from unittest.mock import patch
-from scrapegraphaiapisdk.scrape import scrape
+from scrapegraph_py.scrape import scrape
 
 class TestScrape(unittest.TestCase):
     
-    @patch('scrapegraphaiapisdk.scrape.requests.post')
+    @patch('scrapegraph_py.scrape.requests.post')
     def test_scrape_success(self, mock_post):
         mock_post.return_value.status_code = 200
         mock_post.return_value.text = '{"data": "extracted data"}'
         response = scrape("test_api_key", "http://example.com", "Extract data")
         self.assertEqual(response, '{"data": "extracted data"}')
 
-    @patch('scrapegraphaiapisdk.scrape.requests.post')
+    @patch('scrapegraph_py.scrape.requests.post')
     def test_scrape_http_error(self, mock_post):
         mock_post.side_effect = requests.exceptions.HTTPError
         response = scrape("test_api_key", "http://example.com", "Extract data")

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from scrapegraphaiapisdk.scrape import scrape`
	`1`	`+from scrapegraph_py.scrape import scrape`
`2`	`2`	`from dotenv import load_dotenv # Import load_dotenv`
`3`	`3`	`import os # Import os to access environment variables`
`4`	`4`	`import json # Import json for beautifying output`