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

firecrawl_simple_client-0.1.1.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0eb40b24260893d4fee96ad26df2ac09194d9d4b8f5002f7339b31301d8c2e95
MD5 19213fc2613b63461b6427f151683f3d
BLAKE2b-256 53f6918ae18e135934dad306d16296ca81ce209ae6dd2f8489b6093d0098af33

See more details on using hashes here.

Provenance

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

Publisher: release.yml on darinkishore/simplecrawl

Attestations:

File details

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

File metadata

File hashes

Hashes for firecrawl_simple_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28d0f1bed2b41c00f45f95b1633a789d8d56896c9024cd2fa2e4ec3ddfb33d4c
MD5 69d274a5d288230eb44ff24786aa03cb
BLAKE2b-256 995791ab66645cd319abd8c932048e858b459bb658facae2e19c18ccd1c7df58

See more details on using hashes here.

Provenance

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