sp-client 1.0.0__tar.gz

sp_client-1.0.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: sp-client
+Version: 1.0.0
+Summary: Python library for scraping pros API
+Requires-Python: >=3.8
+Requires-Dist: requests>=2.31.0

sp_client-1.0.0/README.md

@@ -0,0 +1,35 @@
+# SP Client
+
+Python library for the Scraping Pros API.
+
+## Installation
+first go to the pypi URL: https://test.pypi.org/project/sp-client/0.1.0/ and then install the 
+library as it is explicited in the page.
+
+## Quick Start
+```python
+from sp_client import ScrapingPros
+
+# Initialize the client
+client = ScrapingPros(
+    token='your-api-token-here'
+)
+
+# Scrape a website
+result = client.scrape_site(data)
+print(result)
+```
+
+### scrape_site(data)
+Scrapes a website with the instructions set on the data.
+
+**Parameters:**
+- `data`: Dictionary with instructions on how to perform the scraping.
+
+**Example:**
+```python
+data = client.scrape_site(
+    "url": 'https://example.com',
+    "browser": True
+)
+```

sp_client-1.0.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sp-client"
+version = "1.0.0"
+description = "Python library for scraping pros API"
+dependencies = [
+    "requests>=2.31.0",
+]
+requires-python = ">=3.8"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sp_client*"]

sp_client-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sp_client-1.0.0/sp_client/__init__.py

@@ -0,0 +1 @@
+from .scraping_pros_client import ScrapingPros

sp_client-1.0.0/sp_client/scraping_pros_client.py

@@ -0,0 +1,42 @@
+import requests
+import base64
+
+class ScrapingPros:
+    """
+    Class to interact with the Scraping Pros API.
+
+    Args:
+        api_token: authentication token for the API.
+
+    Example:
+        >>> client = ScrapingPros('token123')
+    """
+    def __init__(self, token):
+        self.token = token
+
+
+    def scrape_site(self, data):
+        """
+        Method to scrape a site.
+        
+        Args:
+            data: A dictionary with the instructions to scrape the website. Documentation in:
+                https://gitlab.com/7Puentes/scraping-pros-api/-/blob/master/docs/sync/scrape.md?ref_type=heads
+        
+        Screenshots: 
+            If a screenshot where to be requested, the user needs a "screenshots" folder in their 
+            project so the screenshots are saved inside of said folder.
+        """
+        
+        response = requests.post(
+        "http://localhost:8000/v1/sync/scrape", #change this latter to production API
+        json=data,
+        headers={"Authorization": f"Bearer {self.token}"}
+        )
+        parsed_responsed = response.json()
+        if parsed_responsed.get("screenshot"):
+            jpgtxt = base64.decodebytes(parsed_responsed["screenshot"].encode("utf-8"))
+            with open(f"screenshots/.jpg", "wb") as f:
+                f.write(jpgtxt)
+
+        return parsed_responsed

sp_client-1.0.0/sp_client.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: sp-client
+Version: 1.0.0
+Summary: Python library for scraping pros API
+Requires-Python: >=3.8
+Requires-Dist: requests>=2.31.0

sp_client-1.0.0/sp_client.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+sp_client/__init__.py
+sp_client/scraping_pros_client.py
+sp_client.egg-info/PKG-INFO
+sp_client.egg-info/SOURCES.txt
+sp_client.egg-info/dependency_links.txt
+sp_client.egg-info/requires.txt
+sp_client.egg-info/top_level.txt

sp_client-1.0.0/sp_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sp_client-1.0.0/sp_client.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.31.0

sp_client-1.0.0/sp_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+sp_client