Skip to content

docs(python): refresh for scrapegraph-py >= 2.1.0 #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VinciGit00 merged 2 commits into from
Apr 21, 2026
Merged

docs(python): refresh for scrapegraph-py >= 2.1.0 #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb42933
docs(python): refresh for scrapegraph-py >= 2.1.0
VinciGit00 Apr 21, 2026
2b713b3
tests(python): add v2.1.0 endpoint verification scripts and results
VinciGit00 Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,29 @@ description: 'Install and get started with ScrapeGraphAI v2 SDKs'

## Python SDK

Requires **Python ≥ 3.12**.

```bash
pip install scrapegraph-py
pip install "scrapegraph-py>=2.1.0"
```

**Usage:**

```python
from scrapegraph_py import Client
from scrapegraph_py import ScrapeGraphAI

client = Client(api_key="your-api-key-here")
sgai = ScrapeGraphAI(api_key="your-api-key-here")

# Extract data from a website
response = client.extract(
res = sgai.extract(
"Extract information about the company",
url="https://scrapegraphai.com",
prompt="Extract information about the company"
)
print(response)
print(res.data.json_data if res.status == "success" else res.error)
```

<Note>
You can also set the `SGAI_API_KEY` environment variable and initialize the client without parameters: `client = Client()`
You can also set the `SGAI_API_KEY` environment variable and initialize the client without parameters: `sgai = ScrapeGraphAI()`.
</Note>

For more advanced usage, see the [Python SDK documentation](/sdks/python).
Expand Down Expand Up @@ -110,22 +112,25 @@ Both SDKs support structured output using schemas:
### Python Example

```python
from scrapegraph_py import Client
from pydantic import BaseModel, Field
from scrapegraph_py import ScrapeGraphAI

class CompanyInfo(BaseModel):
company_name: str = Field(description="The company name")
description: str = Field(description="Company description")
website: str = Field(description="Company website URL")
industry: str = Field(description="Industry sector")
sgai = ScrapeGraphAI(api_key="your-api-key")

client = Client(api_key="your-api-key")
response = client.extract(
res = sgai.extract(
"Extract company information",
url="https://scrapegraphai.com",
prompt="Extract company information",
output_schema=CompanyInfo
schema={
"type": "object",
"properties": {
"company_name": {"type": "string", "description": "The company name"},
"description": {"type": "string", "description": "Company description"},
"website": {"type": "string", "description": "Company website URL"},
"industry": {"type": "string", "description": "Industry sector"},
},
"required": ["company_name"],
},
)
print(response)
print(res.data.json_data if res.status == "success" else res.error)
```

### JavaScript Example
Expand Down
Loading