firecrawl 2.4.2__tar.gz → 2.5.0__tar.gz

{firecrawl-2.4.2 → firecrawl-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: firecrawl
-Version: 2.4.2
+Version: 2.5.0
 Summary: Python SDK for Firecrawl API
 Home-page: https://github.com/mendableai/firecrawl
 Author: Mendable.ai
@@ -40,13 +40,13 @@ Requires-Dist: nest-asyncio
 Requires-Dist: pydantic
 Requires-Dist: aiohttp
 
-# Firecrawl  SDK
+# Firecrawl Python SDK
 
-> Firecrawl SDK is a wrapper around the Firecrawl API to help you easily turn websites into markdown.
+The Firecrawl Python SDK is a library that allows you to easily scrape and crawl websites, and output the data in a format ready for use with language models (LLMs). It provides a simple and intuitive interface for interacting with the Firecrawl API.
 
 ## Installation
 
-To install the Firecrawl  SDK, you can use pip:
+To install the Firecrawl Python SDK, you can use pip:
 
 ```bash 
 pip install firecrawl-py
@@ -60,16 +60,16 @@ pip install firecrawl-py
 Here's an example of how to use the SDK:
 
 ```python 
-from firecrawl import FirecrawlApp
+from firecrawl import FirecrawlApp, ScrapeOptions
 
 app = FirecrawlApp(api_key="fc-YOUR_API_KEY")
 
 # Scrape a website:
-scrape_status = app.scrape_url(
+data = app.scrape_url(
   'https://firecrawl.dev', 
   formats=['markdown', 'html']
 )
-print(scrape_status)
+print(data)
 
 # Crawl a website:
 crawl_status = app.crawl_url(

{firecrawl-2.4.2 → firecrawl-2.5.0}/README.md

@@ -1,10 +1,10 @@
-# Firecrawl  SDK
+# Firecrawl Python SDK
 
-> Firecrawl SDK is a wrapper around the Firecrawl API to help you easily turn websites into markdown.
+The Firecrawl Python SDK is a library that allows you to easily scrape and crawl websites, and output the data in a format ready for use with language models (LLMs). It provides a simple and intuitive interface for interacting with the Firecrawl API.
 
 ## Installation
 
-To install the Firecrawl  SDK, you can use pip:
+To install the Firecrawl Python SDK, you can use pip:
 
 ```bash 
 pip install firecrawl-py
@@ -18,16 +18,16 @@ pip install firecrawl-py
 Here's an example of how to use the SDK:
 
 ```python 
-from firecrawl import FirecrawlApp
+from firecrawl import FirecrawlApp, ScrapeOptions
 
 app = FirecrawlApp(api_key="fc-YOUR_API_KEY")
 
 # Scrape a website:
-scrape_status = app.scrape_url(
+data = app.scrape_url(
   'https://firecrawl.dev', 
   formats=['markdown', 'html']
 )
-print(scrape_status)
+print(data)
 
 # Crawl a website:
 crawl_status = app.crawl_url(

{firecrawl-2.4.2 → firecrawl-2.5.0}/firecrawl/__init__.py

@@ -11,9 +11,9 @@ For more information visit https://github.com/firecrawl/
 import logging
 import os
 
-from .firecrawl import FirecrawlApp, JsonConfig, ScrapeOptions # noqa
+from .firecrawl import FirecrawlApp, JsonConfig, ScrapeOptions, ChangeTrackingOptions # noqa
 
-__version__ = "2.4.2"
+__version__ = "2.5.0"
 
 # Define the logger for the Firecrawl project
 logger: logging.Logger = logging.getLogger("firecrawl")

{firecrawl-2.4.2 → firecrawl-2.5.0}/firecrawl/firecrawl.py

@@ -135,6 +135,12 @@ class WebhookConfig(pydantic.BaseModel):
     metadata: Optional[Dict[str, str]] = None
     events: Optional[List[Literal["completed", "failed", "page", "started"]]] = None
 
+class ChangeTrackingOptions(pydantic.BaseModel):
+    """Configuration for change tracking."""
+    modes: Optional[List[Literal["git-diff", "json"]]] = None
+    schema: Optional[Any] = None
+    prompt: Optional[str] = None
+
 class ScrapeOptions(pydantic.BaseModel):
     """Parameters for scraping operations."""
     formats: Optional[List[Literal["markdown", "html", "rawHtml", "content", "links", "screenshot", "screenshot@fullPage", "extract", "json", "changeTracking"]]] = None
@@ -150,6 +156,7 @@ class ScrapeOptions(pydantic.BaseModel):
     removeBase64Images: Optional[bool] = None
     blockAds: Optional[bool] = None
     proxy: Optional[Literal["basic", "stealth"]] = None
+    changeTrackingOptions: Optional[ChangeTrackingOptions] = None
 
 class WaitAction(pydantic.BaseModel):
     """Wait action to perform during scraping."""
@@ -454,6 +461,7 @@ class FirecrawlApp:
             extract: Optional[JsonConfig] = None,
             json_options: Optional[JsonConfig] = None,
             actions: Optional[List[Union[WaitAction, ScreenshotAction, ClickAction, WriteAction, PressAction, ScrollAction, ScrapeAction, ExecuteJavascriptAction]]] = None,
+            change_tracking_options: Optional[ChangeTrackingOptions] = None,
             **kwargs) -> ScrapeResponse[Any]:
         """
         Scrape and extract content from a URL.
@@ -475,6 +483,7 @@ class FirecrawlApp:
           extract (Optional[JsonConfig]): Content extraction settings
           json_options (Optional[JsonConfig]): JSON extraction settings
           actions (Optional[List[Union[WaitAction, ScreenshotAction, ClickAction, WriteAction, PressAction, ScrollAction, ScrapeAction, ExecuteJavascriptAction]]]): Actions to perform
+          change_tracking_options (Optional[ChangeTrackingOptions]): Change tracking settings
 
 
         Returns:
@@ -530,6 +539,9 @@ class FirecrawlApp:
             scrape_params['jsonOptions'] = json_options.dict(exclude_none=True)
         if actions:
             scrape_params['actions'] = [action.dict(exclude_none=True) for action in actions]
+        if change_tracking_options:
+            scrape_params['changeTrackingOptions'] = change_tracking_options.dict(exclude_none=True)
+        
         scrape_params.update(kwargs)
 
         # Make request
@@ -2424,7 +2436,7 @@ class FirecrawlApp:
         method_params = {
             "scrape_url": {"formats", "include_tags", "exclude_tags", "only_main_content", "wait_for", 
                           "timeout", "location", "mobile", "skip_tls_verification", "remove_base64_images",
-                          "block_ads", "proxy", "extract", "json_options", "actions"},
+                          "block_ads", "proxy", "extract", "json_options", "actions", "change_tracking_options"},
             "search": {"limit", "tbs", "filter", "lang", "country", "location", "timeout", "scrape_options"},
             "crawl_url": {"include_paths", "exclude_paths", "max_depth", "max_discovery_depth", "limit",
                          "allow_backward_links", "allow_external_links", "ignore_sitemap", "scrape_options",

{firecrawl-2.4.2 → firecrawl-2.5.0}/firecrawl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: firecrawl
-Version: 2.4.2
+Version: 2.5.0
 Summary: Python SDK for Firecrawl API
 Home-page: https://github.com/mendableai/firecrawl
 Author: Mendable.ai
@@ -40,13 +40,13 @@ Requires-Dist: nest-asyncio
 Requires-Dist: pydantic
 Requires-Dist: aiohttp
 
-# Firecrawl  SDK
+# Firecrawl Python SDK
 
-> Firecrawl SDK is a wrapper around the Firecrawl API to help you easily turn websites into markdown.
+The Firecrawl Python SDK is a library that allows you to easily scrape and crawl websites, and output the data in a format ready for use with language models (LLMs). It provides a simple and intuitive interface for interacting with the Firecrawl API.
 
 ## Installation
 
-To install the Firecrawl  SDK, you can use pip:
+To install the Firecrawl Python SDK, you can use pip:
 
 ```bash 
 pip install firecrawl-py
@@ -60,16 +60,16 @@ pip install firecrawl-py
 Here's an example of how to use the SDK:
 
 ```python 
-from firecrawl import FirecrawlApp
+from firecrawl import FirecrawlApp, ScrapeOptions
 
 app = FirecrawlApp(api_key="fc-YOUR_API_KEY")
 
 # Scrape a website:
-scrape_status = app.scrape_url(
+data = app.scrape_url(
   'https://firecrawl.dev', 
   formats=['markdown', 'html']
 )
-print(scrape_status)
+print(data)
 
 # Crawl a website:
 crawl_status = app.crawl_url(

{firecrawl-2.4.2 → firecrawl-2.5.0}/firecrawl.egg-info/top_level.txt

@@ -1,2 +1,4 @@
+build
+dist
 firecrawl
 tests