firecrawl-py 4.5.0__py3-none-any.whl → 4.6.0__py3-none-any.whl

firecrawl/__init__.py

@@ -17,7 +17,7 @@ from .v1 import (
     V1ChangeTrackingOptions,
 )
 
-__version__ = "4.5.0"
+__version__ = "4.6.0"
 
 # Define the logger for the Firecrawl project
 logger: logging.Logger = logging.getLogger("firecrawl")

firecrawl/__tests__/unit/v2/methods/test_branding.py

@@ -0,0 +1,214 @@
+import pytest
+from unittest.mock import Mock, MagicMock
+from firecrawl.v2.methods.scrape import scrape
+from firecrawl.v2.types import ScrapeOptions, Document
+
+
+class TestBrandingFormat:
+    """Unit tests for branding format support."""
+
+    def test_scrape_with_branding_format_returns_branding_data(self):
+        """Test that scraping with branding format returns branding data."""
+        mock_response = Mock()
+        mock_response.ok = True
+        mock_response.json.return_value = {
+            "success": True,
+            "data": {
+                "markdown": "# Example",
+                "branding": {
+                    "colorScheme": "light",
+                    "colors": {
+                        "primary": "#E11D48",
+                        "secondary": "#3B82F6",
+                        "accent": "#F59E0B"
+                    },
+                    "typography": {
+                        "fontFamilies": {
+                            "primary": "Inter",
+                            "heading": "Poppins"
+                        },
+                        "fontSizes": {
+                            "h1": "2.5rem",
+                            "body": "1rem"
+                        }
+                    },
+                    "spacing": {
+                        "baseUnit": 8
+                    },
+                    "components": {
+                        "buttonPrimary": {
+                            "background": "#E11D48",
+                            "textColor": "#FFFFFF",
+                            "borderRadius": "0.5rem"
+                        }
+                    }
+                }
+            }
+        }
+
+        mock_client = Mock()
+        mock_client.post.return_value = mock_response
+
+        result = scrape(mock_client, "https://example.com", ScrapeOptions(formats=["branding"]))
+
+        assert result.branding is not None
+        assert result.branding.color_scheme == "light"
+        assert result.branding.colors["primary"] == "#E11D48"
+        assert result.branding.typography["fontFamilies"]["primary"] == "Inter"
+        assert result.branding.spacing["baseUnit"] == 8
+        assert result.branding.components["buttonPrimary"]["background"] == "#E11D48"
+
+    def test_scrape_with_branding_and_markdown_formats_returns_both(self):
+        """Test that scraping with both branding and markdown formats returns both."""
+        mock_response = Mock()
+        mock_response.ok = True
+        mock_response.json.return_value = {
+            "success": True,
+            "data": {
+                "markdown": "# Example Content",
+                "branding": {
+                    "colorScheme": "dark",
+                    "colors": {
+                        "primary": "#10B981"
+                    },
+                    "typography": {
+                        "fontFamilies": {
+                            "primary": "Roboto"
+                        }
+                    }
+                }
+            }
+        }
+
+        mock_client = Mock()
+        mock_client.post.return_value = mock_response
+
+        result = scrape(mock_client, "https://example.com", ScrapeOptions(formats=["markdown", "branding"]))
+
+        assert result.markdown == "# Example Content"
+        assert result.branding is not None
+        assert result.branding.color_scheme == "dark"
+        assert result.branding.colors["primary"] == "#10B981"
+
+    def test_scrape_without_branding_format_does_not_return_branding(self):
+        """Test that scraping without branding format does not return branding."""
+        mock_response = Mock()
+        mock_response.ok = True
+        mock_response.json.return_value = {
+            "success": True,
+            "data": {
+                "markdown": "# Example"
+            }
+        }
+
+        mock_client = Mock()
+        mock_client.post.return_value = mock_response
+
+        result = scrape(mock_client, "https://example.com", ScrapeOptions(formats=["markdown"]))
+
+        assert result.markdown == "# Example"
+        assert result.branding is None
+
+    def test_branding_format_with_all_nested_fields(self):
+        """Test branding format with all nested fields populated."""
+        mock_response = Mock()
+        mock_response.ok = True
+        mock_response.json.return_value = {
+            "success": True,
+            "data": {
+                "branding": {
+                    "colorScheme": "light",
+                    "logo": "https://example.com/logo.png",
+                    "fonts": [
+                        {"family": "Inter", "weight": 400},
+                        {"family": "Poppins", "weight": 700}
+                    ],
+                    "colors": {
+                        "primary": "#E11D48",
+                        "background": "#FFFFFF"
+                    },
+                    "typography": {
+                        "fontFamilies": {"primary": "Inter"},
+                        "fontStacks": {"body": ["Inter", "sans-serif"]},
+                        "fontSizes": {"h1": "2.5rem"},
+                        "lineHeights": {"body": 1.5},
+                        "fontWeights": {"regular": 400}
+                    },
+                    "spacing": {
+                        "baseUnit": 8,
+                        "padding": {"sm": 8, "md": 16}
+                    },
+                    "components": {
+                        "buttonPrimary": {
+                            "background": "#E11D48",
+                            "textColor": "#FFFFFF"
+                        }
+                    },
+                    "icons": {
+                        "style": "outline",
+                        "primaryColor": "#E11D48"
+                    },
+                    "images": {
+                        "logo": "https://example.com/logo.png",
+                        "favicon": "https://example.com/favicon.ico"
+                    },
+                    "animations": {
+                        "transitionDuration": "200ms",
+                        "easing": "ease-in-out"
+                    },
+                    "layout": {
+                        "grid": {"columns": 12, "maxWidth": "1200px"},
+                        "headerHeight": "64px"
+                    },
+                    "tone": {
+                        "voice": "professional",
+                        "emojiUsage": "minimal"
+                    },
+                    "personality": {
+                        "tone": "professional",
+                        "energy": "medium",
+                        "targetAudience": "developers"
+                    }
+                }
+            }
+        }
+
+        mock_client = Mock()
+        mock_client.post.return_value = mock_response
+
+        result = scrape(mock_client, "https://example.com", ScrapeOptions(formats=["branding"]))
+
+        assert result.branding is not None
+        assert result.branding.color_scheme == "light"
+        assert result.branding.logo == "https://example.com/logo.png"
+        assert len(result.branding.fonts) == 2
+        assert result.branding.typography["fontStacks"]["body"] == ["Inter", "sans-serif"]
+        assert result.branding.spacing["padding"] == {"sm": 8, "md": 16}
+        assert result.branding.icons["style"] == "outline"
+        assert result.branding.images["favicon"] == "https://example.com/favicon.ico"
+        assert result.branding.animations["easing"] == "ease-in-out"
+        assert result.branding.layout["grid"]["columns"] == 12
+        assert result.branding.personality["tone"] == "professional"
+
+    def test_branding_colorscheme_normalization(self):
+        """Test that colorScheme is normalized to color_scheme."""
+        mock_response = Mock()
+        mock_response.ok = True
+        mock_response.json.return_value = {
+            "success": True,
+            "data": {
+                "branding": {
+                    "colorScheme": "dark",
+                    "colors": {"primary": "#000000"}
+                }
+            }
+        }
+
+        mock_client = Mock()
+        mock_client.post.return_value = mock_response
+
+        result = scrape(mock_client, "https://example.com", ScrapeOptions(formats=["branding"]))
+
+        assert result.branding is not None
+        assert result.branding.color_scheme == "dark"
+        assert not hasattr(result.branding, "colorScheme")

firecrawl/v2/types.py

@@ -124,6 +124,24 @@ class AttributeResult(BaseModel):
     attribute: str
     values: List[str]
 
+class BrandingProfile(BaseModel):
+    """Branding information extracted from a website."""
+    model_config = {"extra": "allow"}
+    
+    color_scheme: Optional[Literal["light", "dark"]] = None
+    logo: Optional[str] = None
+    fonts: Optional[List[Dict[str, Any]]] = None
+    colors: Optional[Dict[str, str]] = None
+    typography: Optional[Dict[str, Any]] = None
+    spacing: Optional[Dict[str, Any]] = None
+    components: Optional[Dict[str, Any]] = None
+    icons: Optional[Dict[str, str]] = None
+    images: Optional[Dict[str, Optional[str]]] = None
+    animations: Optional[Dict[str, str]] = None
+    layout: Optional[Dict[str, Any]] = None
+    tone: Optional[Dict[str, str]] = None
+    personality: Optional[Dict[str, Any]] = None
+
 class Document(BaseModel):
     """A scraped document."""
     markdown: Optional[str] = None
@@ -138,6 +156,7 @@ class Document(BaseModel):
     actions: Optional[Dict[str, Any]] = None
     warning: Optional[str] = None
     change_tracking: Optional[Dict[str, Any]] = None
+    branding: Optional[BrandingProfile] = None
 
     @property
     def metadata_typed(self) -> DocumentMetadata:
@@ -199,7 +218,7 @@ CategoryOption = Union[str, Category]
 
 FormatString = Literal[
     # camelCase versions (API format)
-    "markdown", "html", "rawHtml", "links",  "images", "screenshot", "summary", "changeTracking", "json", "attributes",
+    "markdown", "html", "rawHtml", "links",  "images", "screenshot", "summary", "changeTracking", "json", "attributes", "branding",
     # snake_case versions (user-friendly)
     "raw_html", "change_tracking"
 ]

firecrawl/v2/utils/normalize.py

@@ -83,6 +83,7 @@ def normalize_document_input(doc: Dict[str, Any]) -> Dict[str, Any]:
     Normalize a raw Document dict from the API into the Python SDK's expected shape:
     - Convert top-level keys rawHtml->raw_html, changeTracking->change_tracking
     - Convert metadata keys from camelCase to snake_case
+    - Convert branding.colorScheme to branding.color_scheme
     """
     normalized = dict(doc)
 
@@ -102,6 +103,12 @@ def normalize_document_input(doc: Dict[str, Any]) -> Dict[str, Any]:
             # Fallback to mapped dict if model construction fails for any reason
             normalized["metadata"] = mapped
 
+    # Normalize branding top-level camelCase keys
+    branding = normalized.get("branding")
+    if isinstance(branding, dict):
+        if "colorScheme" in branding and "color_scheme" not in branding:
+            branding["color_scheme"] = branding.pop("colorScheme")
+
     return normalized
 
 

{firecrawl_py-4.5.0.dist-info → firecrawl_py-4.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: firecrawl-py
-Version: 4.5.0
+Version: 4.6.0
 Summary: Python SDK for Firecrawl API
 Home-page: https://github.com/firecrawl/firecrawl
 Author: Mendable.ai

{firecrawl_py-4.5.0.dist-info → firecrawl_py-4.6.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-firecrawl/__init__.py,sha256=h5JuKDOp26ACul3BYZGHNqnTW8xeuPd7kiSSPtW1tVo,2192
+firecrawl/__init__.py,sha256=6p6XlO31z9YF4NSnKZfUjXKA0s0xfp6q1biEfvnnlfU,2192
 firecrawl/client.py,sha256=Lmrg2jniCETU6_xVMn_fgLrgDXiBixK9hSkkdsCGiog,11840
 firecrawl/firecrawl.backup.py,sha256=v1FEN3jR4g5Aupg4xp6SLkuFvYMQuUKND2YELbYjE6c,200430
 firecrawl/types.py,sha256=RmLTq14Z-Nf883wgZxubrtn2HDu9mecsCEdcIdBCu14,2923
@@ -21,6 +21,7 @@ firecrawl/__tests__/e2e/v2/aio/test_aio_search.py,sha256=_IkHkIuvWY6vH99EsqrCZuK
 firecrawl/__tests__/e2e/v2/aio/test_aio_usage.py,sha256=lVGfwR79eaZamUZXgKStUJcpclCnnlpwHGo2pMOUhCY,1255
 firecrawl/__tests__/e2e/v2/aio/test_aio_watcher.py,sha256=hwES4Nu5c0hniZ9heIPDfvh_2JmJ2wPoX9ULTZ0Asjs,1471
 firecrawl/__tests__/unit/v2/methods/test_batch_request_preparation.py,sha256=xAx-aH4bD6uCWavg1cw_8-9FnLIFJNkvVPyOCVJ7r2E,4052
+firecrawl/__tests__/unit/v2/methods/test_branding.py,sha256=f5DkvCMSQKcLEvzByOO0Ae3FuCSj8YzJjDvey6svJJM,8281
 firecrawl/__tests__/unit/v2/methods/test_crawl_params.py,sha256=p9hzg14uAs1iHKXPDSXhGU6hEzPBF_Ae34RAf5XYa10,2387
 firecrawl/__tests__/unit/v2/methods/test_crawl_request_preparation.py,sha256=PEKbooNXfQwPpvcPHXABJnveztgAA-RFBhtlSs8uPro,8780
 firecrawl/__tests__/unit/v2/methods/test_crawl_validation.py,sha256=kErOmHSD01eMjXiMd4rgsMVGd_aU2G9uVymBjbAFoGw,3918
@@ -46,7 +47,7 @@ firecrawl/v1/client.py,sha256=2Rq38RxGnuf2dMCmr4cc3f-ythavcBkUyJmRrwLmMHg,208104
 firecrawl/v2/__init__.py,sha256=Jc6a8tBjYG5OPkjDM5pl-notyys-7DEj7PLEfepv3fc,137
 firecrawl/v2/client.py,sha256=32gO-51LVD2RqPO4o-4WLHLWKQIq-mA8aAbhS8fRftA,33675
 firecrawl/v2/client_async.py,sha256=ZgCcU3Ro_3PfqJ_tilBWcRqJr7BbQVd9VIVVOcftvr4,13963
-firecrawl/v2/types.py,sha256=wQLlJ3gc-EBWI6zMr_01P3U8M02772I_prhB7JUGNYA,26428
+firecrawl/v2/types.py,sha256=a884jU6YruCAqSu8BFqGMM82j6UqK9oK111XLtqv-cY,27227
 firecrawl/v2/watcher.py,sha256=FOU71tqSKxgeuGycu4ye0SLc2dw7clIcoQjPsi-4Csc,14229
 firecrawl/v2/watcher_async.py,sha256=dMMACMgeKrne_xSYeRvPu0m8nXqdNkDEsaiNBiD5ilw,10370
 firecrawl/v2/methods/batch.py,sha256=-eGnCGgB76pY-BFVKG1DC58XViETWukQXtDU0esU_UU,14865
@@ -69,13 +70,13 @@ firecrawl/v2/utils/error_handler.py,sha256=Iuf916dHphDY8ObNNlWy75628DFeJ0Rv8ljRp
 firecrawl/v2/utils/get_version.py,sha256=0CxW_41q2hlzIxEWOivUCaYw3GFiSIH32RPUMcIgwAY,492
 firecrawl/v2/utils/http_client.py,sha256=0hII3mnF_1Vd1nElu-hC9PipTUABGamUKb27q92_m5E,6068
 firecrawl/v2/utils/http_client_async.py,sha256=Mt6Dw_i2R_W81ONXnl9N_AlPiggfylOPfbD5Rpgi7tA,1991
-firecrawl/v2/utils/normalize.py,sha256=nlTU6QRghT1YKZzNZlIQj4STSRuSUGrS9cCErZIcY5w,3636
+firecrawl/v2/utils/normalize.py,sha256=JywPBsUsv6dEf_lKb77r9EZF09ltsY6gmppEKZC51jA,3964
 firecrawl/v2/utils/validation.py,sha256=zzpCK4McM4P8Cag0_8s-d7Ww0idyTWKB4-yk92MT-rY,15405
-firecrawl_py-4.5.0.dist-info/licenses/LICENSE,sha256=nPCunEDwjRGHlmjvsiDUyIWbkqqyj3Ej84ntnh0g0zA,1084
+firecrawl_py-4.6.0.dist-info/licenses/LICENSE,sha256=nPCunEDwjRGHlmjvsiDUyIWbkqqyj3Ej84ntnh0g0zA,1084
 tests/test_api_key_handling.py,sha256=iNaHp6zc9bIwpN3DdiWB2Rzk0j7HCP7VgpRE_1byNYc,1303
 tests/test_change_tracking.py,sha256=_IJ5ShLcoj2fHDBaw-nE4I4lHdmDB617ocK_XMHhXps,4177
 tests/test_timeout_conversion.py,sha256=PWlIEMASQNhu4cp1OW_ebklnE9NCiigPnEFCtI5N3w0,3996
-firecrawl_py-4.5.0.dist-info/METADATA,sha256=PH1cM0pGLdc5Tk9E4GQo8eJjmPFBwSx-6jvjc7_ijVk,7395
-firecrawl_py-4.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-firecrawl_py-4.5.0.dist-info/top_level.txt,sha256=8T3jOaSN5mtLghO-R3MQ8KO290gIX8hmfxQmglBPdLE,16
-firecrawl_py-4.5.0.dist-info/RECORD,,
+firecrawl_py-4.6.0.dist-info/METADATA,sha256=z7fkdTFXovkdZ1_th5LTnix5M6h2Bw1uvWI3-XHdAmc,7395
+firecrawl_py-4.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+firecrawl_py-4.6.0.dist-info/top_level.txt,sha256=8T3jOaSN5mtLghO-R3MQ8KO290gIX8hmfxQmglBPdLE,16
+firecrawl_py-4.6.0.dist-info/RECORD,,