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.
1 maintainer
Metadata
1 maintainer
Release files for firecrawl-simple-client 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| firecrawl_simple_client-0.1.3.tar.gz | 7.2 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| firecrawl_simple_client-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.2 kB
Release files / firecrawl_simple_client-0.1.3.tar.gz
| Download URL | firecrawl_simple_client-0.1.3.tar.gz |
|---|---|
| Size | 7.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e4252b0f641b4cdc1aed66fca766dba96743252e2b35abad2e7bae4080ea23d7
|
|
BLAKE2b-256 checksum How to use checksums |
36ca11fcbe6aa2a6a7eedcc730a635a6c097524d4b9e063edf8ab95e9a415305
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2024.
Transparency logRelease files / firecrawl_simple_client-0.1.3-py3-none-any.whl
| Download URL | firecrawl_simple_client-0.1.3-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f52f2ad3982e456f5391e4e9445f06bdbdf189bcda915636a5c46f8a4962e69
|
|
BLAKE2b-256 checksum How to use checksums |
86ff04ea4d7e9ba9396a58239656da2b780867d74a42943e100e621a4ecebb02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2024.
Transparency logSecurity for firecrawl-simple-client 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for firecrawl_simple_client-0.1.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2024.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
