Skip to main content

Python client for Firecrawl-Simple

Project description

SimpleCrawl

A typed client for the firecrawl-simple self-hosted API.

Installation

pip install firecrawl-simple-client

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

firecrawl_simple_client-0.1.3.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

firecrawl_simple_client-0.1.3-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file firecrawl_simple_client-0.1.3.tar.gz.

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e4252b0f641b4cdc1aed66fca766dba96743252e2b35abad2e7bae4080ea23d7
MD5 8c5c20e7e56bbe55d9b2d49e1f557216
BLAKE2b-256 36ca11fcbe6aa2a6a7eedcc730a635a6c097524d4b9e063edf8ab95e9a415305

See more details on using hashes here.

Provenance

The following attestation bundles were made for firecrawl_simple_client-0.1.3.tar.gz:

Publisher: release.yml on darinkishore/simplecrawl

Attestations:

File details

Details for the file firecrawl_simple_client-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8f52f2ad3982e456f5391e4e9445f06bdbdf189bcda915636a5c46f8a4962e69
MD5 0baeb8664d2fab68c5683bcd00ab5436
BLAKE2b-256 86ff04ea4d7e9ba9396a58239656da2b780867d74a42943e100e621a4ecebb02

See more details on using hashes here.

Provenance

The following attestation bundles were made for firecrawl_simple_client-0.1.3-py3-none-any.whl:

Publisher: release.yml on darinkishore/simplecrawl

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page