firecrawl-py 0.0.3__tar.gz

firecrawl-py-0.0.3/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: firecrawl-py
+Version: 0.0.3
+Summary: Python SDK for Firecrawl API
+Home-page: https://github.com/mendableai/firecrawl-py
+Author: Eric Ciarla
+Author-email: nick@mendable.ai

firecrawl-py-0.0.3/README.md

@@ -0,0 +1,156 @@
+# Mendable Python SDK
+
+This is a Python SDK for Mendable.ai, which provides a Python interface to interact with Mendable.ai's API.
+
+## Installation
+
+To install this package, use pip:
+
+```bash
+pip install mendable-py
+```
+
+## Prerequisites
+
+To use this package, you'll need to obtain an API key from Mendable.ai and make it available as an environment variable or set it in the constructor.
+
+In your environment (add to .env file):
+
+```bash
+MENDABLE_API_KEY=your_api_key
+```
+
+OR
+
+```python
+my_chat_bot = ChatApp(api_key="your-api-key")
+```
+
+
+## Basic Usage
+
+You can use this package to add sources to Mendable and ask questions to it (history is an option parameter):
+
+```python
+from mendable import ChatApp
+
+my_chat_bot = ChatApp(api_key="your-api-key")
+
+my_chat_bot.add("url", "https://www.mendable.ai/")
+
+answer = my_chat_bot.ask(question="What is Mendable?", history=[{ "prompt" : "How do I create a new project?", "response" : "You can create a new project by going to the projects page and clicking the new project button." }])
+
+print(answer['answer']['text'])
+```
+
+Here is what the ask methods response object looks like:
+
+```json
+{
+  "answer": {
+    "text": "This is how to deploy it..."
+  },
+  "message_id": 123,
+  "sources": [
+    {
+      "id": 866,
+      "content":"",
+      "link": "",
+      "relevance_score": 0.99
+    },
+  ]
+}
+```
+
+
+## Rate Message
+
+This is how you can rate a message positive (1) or negative (0).
+
+```python
+from mendable import ChatApp
+
+my_chat_bot = ChatApp(api_key="your-api-key")
+
+my_chat_bot.add("url", "https://www.mendable.ai/")
+
+answer = my_chat_bot.ask(question="What is Mendable?", history=[{ "prompt" : "How do I create a new project?", "response" : "You can create a new project by going to the projects page and clicking the new project button." }])
+
+message_id = answer["message_id"]
+
+my_chat_bot.rate_message(message_id, 1)
+```
+
+## See all sources for project
+
+This method lists all unique sources for a project.
+
+```python
+from mendable import ChatApp
+
+my_chat_bot = ChatApp(api_key="your-api-key")
+
+my_chat_bot.add("url", "https://www.mendable.ai/")
+
+my_chat_bot.get_sources()
+
+```
+
+The response object looks like this:
+```json
+[
+  {
+    "id": 52,
+    "source": "https://mendable.ai"
+  },
+  ..
+]
+```
+
+## Add and Delete Indexes
+
+You can also check/delete indexes using `get_sources` and `delete_source` functions:
+
+```python
+from mendable import ChatApp
+
+my_chat_bot = ChatApp(api_key="your-api-key")
+
+my_chat_bot.add("url", "https://www.mendable.ai/")
+
+my_chat_bot.get_sources()
+
+my_chat_bot.delete_source("https://www.mendable.ai/")
+```
+
+### Supported ingestion formats and type
+
+- Website Crawler URL -> "website-crawler"
+- Docusaurus site URL -> "docusaurus"
+- GitHub Repo URL -> "github"
+- YouTube Video URL -> "youtube"
+- Single Website URL -> "url"
+- Sitemap URL -> "sitemap"
+- OpenAPI YAML URL -> "openapi"
+
+## Start new conversation
+
+This method makes a new conversation for a given project
+
+```python
+from mendable import ChatApp
+
+my_chat_bot = ChatApp(api_key="your-api-key")
+
+my_chat_bot.start_new_conversation()
+
+```
+
+
+## License
+
+This project is licensed under the terms of the MIT license.
+
+---
+
+Please make sure to replace `your_api_key` with your actual API key and modify any part of this README according to your needs before adding it to your package.

firecrawl-py-0.0.3/firecrawl/__init__.py

@@ -0,0 +1 @@
+from .firecrawl import FirecrawlApp

firecrawl-py-0.0.3/firecrawl/firecrawl.py

@@ -0,0 +1,78 @@
+import os
+import requests
+
+class FirecrawlApp:
+    def __init__(self, api_key=None):
+        self.api_key = api_key or os.getenv('FIRECRAWL_API_KEY')
+        if self.api_key is None:
+            raise ValueError('No API key provided')
+    
+    def scrape_url(self, url, params):
+        headers = {
+            'Content-Type': 'application/json',
+            'Authorization': f'Bearer {self.api_key}'
+        }
+        response = requests.post(
+            'https://api.firecrawl.dev/v0/scrape',
+            headers=headers,
+            json={'url': url, **params}
+        )
+        if response.status_code == 200:
+            return response.json()
+        elif response.status_code in [402, 409, 500]:
+            error_message = response.json().get('error', 'Unknown error occurred')
+            raise Exception(f'Failed to scrape URL. Status code: {response.status_code}. Error: {error_message}')
+        else:
+            raise Exception(f'Failed to scrape URL. Status code: {response.status_code}')
+
+    def crawl_url(self, url, params):
+        import time
+        headers = self._prepare_headers()
+        response = self._post_request('https://api.firecrawl.dev/v0/crawl', {'url': url, **params}, headers)
+        if response.status_code == 200:
+            job_id = response.json().get('jobId')
+            return self._monitor_job_status(job_id, headers)
+        else:
+            self._handle_error(response, 'start crawl job')
+
+    def check_crawl_status(self, job_id):
+        headers = self._prepare_headers()
+        response = self._get_request(f'https://api.firecrawl.dev/v0/crawl/status/{job_id}', headers)
+        if response.status_code == 200:
+            return response.json()
+        else:
+            self._handle_error(response, 'check crawl status')
+
+    def _prepare_headers(self):
+        return {
+            'Content-Type': 'application/json',
+            'Authorization': f'Bearer {self.api_key}'
+        }
+
+    def _post_request(self, url, data, headers):
+        return requests.post(url, headers=headers, json=data)
+
+    def _get_request(self, url, headers):
+        return requests.get(url, headers=headers)
+
+    def _monitor_job_status(self, job_id, headers):
+        import time
+        while True:
+            status_response = self._get_request(f'https://api.firecrawl.dev/v0/crawl/status/{job_id}', headers)
+            if status_response.status_code == 200:
+                status_data = status_response.json()
+                if status_data['status'] == 'completed':
+                    return status_data
+                elif status_data['status'] in ['active', 'paused', 'pending', 'queued']:
+                    time.sleep(2)  # Wait for 2 seconds before checking again
+                else:
+                    raise Exception(f'Crawl job failed or was stopped. Status: {status_data["status"]}')
+            else:
+                self._handle_error(status_response, 'check crawl status')
+
+    def _handle_error(self, response, action):
+        if response.status_code in [402, 409, 500]:
+            error_message = response.json().get('error', 'Unknown error occurred')
+            raise Exception(f'Failed to {action}. Status code: {response.status_code}. Error: {error_message}')
+        else:
+            raise Exception(f'Unexpected error occurred while trying to {action}. Status code: {response.status_code}')

firecrawl-py-0.0.3/firecrawl_py.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: firecrawl-py
+Version: 0.0.3
+Summary: Python SDK for Firecrawl API
+Home-page: https://github.com/mendableai/firecrawl-py
+Author: Eric Ciarla
+Author-email: nick@mendable.ai

firecrawl-py-0.0.3/firecrawl_py.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+setup.py
+firecrawl/__init__.py
+firecrawl/firecrawl.py
+firecrawl_py.egg-info/PKG-INFO
+firecrawl_py.egg-info/SOURCES.txt
+firecrawl_py.egg-info/dependency_links.txt
+firecrawl_py.egg-info/requires.txt
+firecrawl_py.egg-info/top_level.txt

firecrawl-py-0.0.3/firecrawl_py.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

firecrawl-py-0.0.3/firecrawl_py.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

firecrawl-py-0.0.3/firecrawl_py.egg-info/top_level.txt

@@ -0,0 +1 @@
+firecrawl

firecrawl-py-0.0.3/setup.cfg

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

firecrawl-py-0.0.3/setup.py

@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='firecrawl-py',
+    version='0.0.3',
+    url='https://github.com/mendableai/firecrawl-py',
+    author='Eric Ciarla',
+    author_email='nick@mendable.ai',
+    description='Python SDK for Firecrawl API',
+    packages=find_packages(),    
+    install_requires=[
+        'requests',
+    ],
+)