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.2.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

firecrawl_simple_client-0.1.2-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.2.tar.gz
Algorithm Hash digest
SHA256 25a2d8c3b6073affacb4f4cead81b91788352c6341cfb201b7acaa54371d5c0a
MD5 15ceae86a5771c0f29d8acd668eecbdc
BLAKE2b-256 f3d24b9d084065bd7f1021df9f002de3852c72cdfbf2476c813cff828aae4cd8

See more details on using hashes here.

Provenance

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

Publisher: release.yml on darinkishore/simplecrawl

Attestations:

File details

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

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5ba33d904b64a5c639fe8c1f821939d3f37abce5eea1b280a8276f122b5b1bf
MD5 122fbe1a12726ee05ffbf40b6d290719
BLAKE2b-256 848aa9d176c1a7cc210c78d8387940cdda4bde30bc93ae94d1f8e0956301d351

See more details on using hashes here.

Provenance

The following attestation bundles were made for firecrawl_simple_client-0.1.2-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