AI/firecrawl
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/mendableai/firecrawl synced 2025-08-06 06:36:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: update doc and libs

Browse Source
This commit is contained in:
sanix-darker 2024-07-12 15:22:55 +02:00
parent 6ea36d38f3
commit 80af390557
No known key found for this signature in database
GPG Key ID: 02BD1EB7C7D57CD3
2 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apps/rust-sdk/Cargo.toml
View File

@ -21,10 +21,7 @@ serde_json = "^1.0"
log = "^0.4"
thiserror = "^1.0"
uuid = { version = "^1.10", features = ["v4"] }
[dependencies.tokio]
version = "1"
features = ["full"]
tokio = { version = "^1", features = ["full"] }
[dev-dependencies]
clippy = "^0.0.302"

26
apps/rust-sdk/README.md
View File

@ -8,9 +8,18 @@ To install the Firecrawl Rust SDK, add the following to your `Cargo.toml`:
```toml
[dependencies]
firecrawl_rs = "0.1"
firecrawl_rs = "^0.1"
tokio = { version = "^1", features = ["full"] }
serde = { version = "^1.0", features = ["derive"] }
serde_json = "^1.0"
uuid = { version = "^1.10", features = ["v4"] }
[build-dependencies]
tokio = { version = "1", features = ["full"] }
```
To add it in your codebase.
## Usage
1. Get an API key from [firecrawl.dev](https://firecrawl.dev)
@ -37,6 +46,7 @@ async fn main() {
To scrape a single URL, use the `scrape_url` method. It takes the URL as a parameter and returns the scraped data as a `serde_json::Value`.
```rust
// Example scrape code...
let scrape_result = app.scrape_url("https://example.com", None).await;
match scrape_result {
Ok(data) => println!("Scrape Result:\n{}", data["markdown"]),
@ -82,6 +92,7 @@ let llm_extraction_params = json!({
}
});
// Example scrape code...
let llm_extraction_result = app
.scrape_url("https://news.ycombinator.com", Some(llm_extraction_params))
.await;
@ -119,6 +130,8 @@ let crawl_params = json!({
"excludes": ["blog/*"]
}
});
// Example crawl code...
let crawl_result = app
.crawl_url("https://example.com", Some(crawl_params), true, 2, idempotency_key)
.await;
@ -154,16 +167,9 @@ To ensure the functionality of the Firecrawl Rust SDK, we have included end-to-e
### Running the Tests
To run the tests, execute the following commands:
Install the test dependencies:
```bash
cargo install --dev
```
Run:
```bash
export $(xargs < ./tests/.env)
cargo test --test e2e_with_auth
$ export $(xargs < ./tests/.env)
$ cargo test --test e2e_with_auth
```
## Contributing