Metadata-Version: 2.4
Name: gcrawl-sdk
Version: 0.1.1
Summary: Python SDK for GCrawl — Scrape, crawl, screenshot, links, and search with ease
Author-email: Ramkumar <ramkumarlpm4@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Gramosoft
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/GramosoftAI/GCrawl
Keywords: crawl,scraper,screenshot,links,gcrawl,ai
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Dynamic: license-file

# gcrawl-sdk

Official Python SDK for GCrawl — Scrape, crawl, screenshot, fetch links, and search web pages with ease.

## Installation

```bash
pip install gcrawl-sdk
```

## Quick Start

```python
from gcrawl_sdk import GcrawlClient, ScrapeOptions

client = GcrawlClient(api_key="your-api-key")

# Scrape a website (synchronous polling)
result = client.scrape(
    url="https://gramosoft.tech",
    options=ScrapeOptions(markdown_enabled=True, screenshot_enabled=True),
    wait=True
)
print("Scraped Markdown:", result.markdown)
print("Screenshot URL:", result.screenshot_url)

# Search web synchronously
search_res = client.search("gramosoft", limit=5, geo="IN")
for res in search_res.results:
    print(res.position, res.title, res.url)
```

## API Key

Set your API key as an environment variable:
```bash
export GCRAWL_API_KEY="your-api-key"
```

Or pass it directly to the client:
```python
client = GcrawlClient(api_key="your-api-key")
```
