From 971e1f85c45341645214d0f8ea3fa5de202e78fb Mon Sep 17 00:00:00 2001
From: Matt Joyce <matt.joyce@gmail.com>
Date: Thu, 23 May 2024 08:03:58 +1000
Subject: [PATCH] Added module docstring

PyLint C0114 - missing-module-docstring
---
 apps/python-sdk/firecrawl/firecrawl.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/apps/python-sdk/firecrawl/firecrawl.py b/apps/python-sdk/firecrawl/firecrawl.py
index 2b7121a..23934cf 100644
--- a/apps/python-sdk/firecrawl/firecrawl.py
+++ b/apps/python-sdk/firecrawl/firecrawl.py
@@ -1,3 +1,15 @@
+"""
+FirecrawlApp Module
+
+This module provides a class `FirecrawlApp` for interacting with the Firecrawl API.
+It includes methods to scrape URLs, perform searches, initiate and monitor crawl jobs,
+and check the status of these jobs. The module uses requests for HTTP communication
+and handles retries for certain HTTP status codes.
+
+Classes:
+    - FirecrawlApp: Main class for interacting with the Firecrawl API.
+"""
+
 import os
 from typing import Any, Dict, Optional
 import requests