Python client for Firecrawl-Simple
Project description
SimpleCrawl
A typed client for the firecrawl-simple
self-hosted API.
Installation
pip install simplecrawl
Quick Start
Synchronous Usage
export FIRECRAWL_URL_BASE="url"
from simplecrawl import Client
# Initialize client
client = Client(base_url="some-url", ) # defaults to https://api.firecrawl.dev/v1 as base URL if not found in environment
# Scrape a single page
result = client.scrape("https://example.com")
print(result.markdown)
print(result.metadata.title)
# Crawl multiple pages
job = client.crawl(
"https://example.com",
include_paths=["/blog/*"],
max_depth=2,
limit=10
)
Async Usage
import asyncio
from simplecrawl import AsyncClient
async def main():
async with AsyncClient(token="your-api-token") as client:
result = await client.scrape("https://example.com")
print(result.markdown)
asyncio.run(main())
Features
- Synchronous and asynchronous clients
- Single page scraping
- Multi-page crawling
- URL discovery/mapping
- Content format options (Markdown, HTML, Links, etc.)
- Customizable scraping options
Documentation
For detailed examples, check out the examples folder.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file firecrawl_simple_client-0.1.1.tar.gz
.
File metadata
- Download URL: firecrawl_simple_client-0.1.1.tar.gz
- Upload date:
- Size: 27.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eb40b24260893d4fee96ad26df2ac09194d9d4b8f5002f7339b31301d8c2e95 |
|
MD5 | 19213fc2613b63461b6427f151683f3d |
|
BLAKE2b-256 | 53f6918ae18e135934dad306d16296ca81ce209ae6dd2f8489b6093d0098af33 |
Provenance
The following attestation bundles were made for firecrawl_simple_client-0.1.1.tar.gz
:
Publisher:
release.yml
on darinkishore/simplecrawl
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
firecrawl_simple_client-0.1.1.tar.gz
- Subject digest:
0eb40b24260893d4fee96ad26df2ac09194d9d4b8f5002f7339b31301d8c2e95
- Sigstore transparency entry: 149001899
- Sigstore integration time:
- Predicate type:
File details
Details for the file firecrawl_simple_client-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: firecrawl_simple_client-0.1.1-py3-none-any.whl
- Upload date:
- Size: 2.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28d0f1bed2b41c00f45f95b1633a789d8d56896c9024cd2fa2e4ec3ddfb33d4c |
|
MD5 | 69d274a5d288230eb44ff24786aa03cb |
|
BLAKE2b-256 | 995791ab66645cd319abd8c932048e858b459bb658facae2e19c18ccd1c7df58 |
Provenance
The following attestation bundles were made for firecrawl_simple_client-0.1.1-py3-none-any.whl
:
Publisher:
release.yml
on darinkishore/simplecrawl
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
firecrawl_simple_client-0.1.1-py3-none-any.whl
- Subject digest:
28d0f1bed2b41c00f45f95b1633a789d8d56896c9024cd2fa2e4ec3ddfb33d4c
- Sigstore transparency entry: 149001900
- Sigstore integration time:
- Predicate type: