Added module docstring

PyLint C0114 - missing-module-docstring
This commit is contained in:
Matt Joyce 2024-05-23 08:03:58 +10:00
parent 8d041c05b4
commit 971e1f85c4

View File

@ -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