mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
101 lines
3.4 KiB
Plaintext
101 lines
3.4 KiB
Plaintext
---
|
|
title: Serper Scrape Website
|
|
description: The `SerperScrapeWebsiteTool` is designed to scrape websites and extract clean, readable content using Serper's scraping API.
|
|
icon: globe
|
|
mode: "wide"
|
|
---
|
|
|
|
# `SerperScrapeWebsiteTool`
|
|
|
|
## Description
|
|
|
|
This tool is designed to scrape website content and extract clean, readable text from any website URL. It utilizes the [serper.dev](https://serper.dev) scraping API to fetch and process web pages, optionally including markdown formatting for better structure and readability.
|
|
|
|
## Installation
|
|
|
|
To effectively use the `SerperScrapeWebsiteTool`, follow these steps:
|
|
|
|
1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
|
|
2. **API Key Acquisition**: Acquire a `serper.dev` API key by registering for an account at `serper.dev`.
|
|
3. **Environment Configuration**: Store your obtained API key in an environment variable named `SERPER_API_KEY` to facilitate its use by the tool.
|
|
|
|
To incorporate this tool into your project, follow the installation instructions below:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
The following example demonstrates how to initialize the tool and scrape a website:
|
|
|
|
```python Code
|
|
from crewai_tools import SerperScrapeWebsiteTool
|
|
|
|
# Initialize the tool for website scraping capabilities
|
|
tool = SerperScrapeWebsiteTool()
|
|
|
|
# Scrape a website with markdown formatting
|
|
result = tool.run(url="https://example.com", include_markdown=True)
|
|
```
|
|
|
|
## Arguments
|
|
|
|
The `SerperScrapeWebsiteTool` accepts the following arguments:
|
|
|
|
- **url**: Required. The URL of the website to scrape.
|
|
- **include_markdown**: Optional. Whether to include markdown formatting in the scraped content. Defaults to `True`.
|
|
|
|
## Example with Parameters
|
|
|
|
Here is an example demonstrating how to use the tool with different parameters:
|
|
|
|
```python Code
|
|
from crewai_tools import SerperScrapeWebsiteTool
|
|
|
|
tool = SerperScrapeWebsiteTool()
|
|
|
|
# Scrape with markdown formatting (default)
|
|
markdown_result = tool.run(
|
|
url="https://docs.crewai.com",
|
|
include_markdown=True
|
|
)
|
|
|
|
# Scrape without markdown formatting for plain text
|
|
plain_result = tool.run(
|
|
url="https://docs.crewai.com",
|
|
include_markdown=False
|
|
)
|
|
|
|
print("Markdown formatted content:")
|
|
print(markdown_result)
|
|
|
|
print("\nPlain text content:")
|
|
print(plain_result)
|
|
```
|
|
|
|
## Use Cases
|
|
|
|
The `SerperScrapeWebsiteTool` is particularly useful for:
|
|
|
|
- **Content Analysis**: Extract and analyze website content for research purposes
|
|
- **Data Collection**: Gather structured information from web pages
|
|
- **Documentation Processing**: Convert web-based documentation into readable formats
|
|
- **Competitive Analysis**: Scrape competitor websites for market research
|
|
- **Content Migration**: Extract content from existing websites for migration purposes
|
|
|
|
## Error Handling
|
|
|
|
The tool includes comprehensive error handling for:
|
|
|
|
- **Network Issues**: Handles connection timeouts and network errors gracefully
|
|
- **API Errors**: Provides detailed error messages for API-related issues
|
|
- **Invalid URLs**: Validates and reports issues with malformed URLs
|
|
- **Authentication**: Clear error messages for missing or invalid API keys
|
|
|
|
## Security Considerations
|
|
|
|
- Always store your `SERPER_API_KEY` in environment variables, never hardcode it in your source code
|
|
- Be mindful of rate limits imposed by the Serper API
|
|
- Respect robots.txt and website terms of service when scraping content
|
|
- Consider implementing delays between requests for large-scale scraping operations |