rocketscraper

Name	rocketscraper JSON
Version	0.0.3 JSON
	download
home_page	None
Summary	Python SDK for the Rocket Scraper API.
upload_time	2024-10-19 04:31:52
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords	rocketscraper api web-scraping ai
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Rocket Scraper API Python SDK

Python SDK for the [Rocket Scraper API](https://rocketscraper.com). For more information, visit the [GitHub repository](https://github.com/rocketscraper/rocketscraper-sdk-python).

## Requirements

- [Python](https://www.python.org/) version 3.7 or above

## Installation

```bash
pip install rocketscraper
```

## Usage

To use the SDK, you need to create a new instance of the `RocketClient` class and pass your API key as an argument.

### Setup

```python
from rocketscraper import RocketClient

rocket_client = RocketClient(api_key='YOUR_API_KEY')
```

### Scrape

The `scrape` method allows you to scrape data from a website using a schema. The method returns the scraped data in the format specified in the schema.

```python
data = rocket_client.scrape(
    url='https://ycombinator.com/companies/pagerduty',
    schema={
        'company': 'string',
        'image_url': 'string',
        'founded_at': 'string',
        'size': 'integer',
        'location': 'string',
        'short_description': 'string',
        'long_description': 'string',
        'is_active': 'boolean',
        'founders': [
            {
                'name': 'string',
                'role': 'string',
            },
        ],
    }
)

print(data)
```

For more details, visit the [Python SDK GitHub repository](https://github.com/rocketscraper/rocketscraper-sdk-python).

## Documentation

For more information on how to use the Rocket Scraper API, visit the [Rocket Scraper API documentation](https://docs.rocketscraper.com).

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/rocketscraper/rocketscraper-sdk-python/blob/main/LICENSE) file for more details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rocketscraper",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "rocketscraper, api, web-scraping, ai",
    "author": null,
    "author_email": "Rocket Scraper API <support@rocketscraper.com>",
    "download_url": "https://files.pythonhosted.org/packages/5c/b8/5ddd1ed172e9262896459fd0c264ee22ca1b535d6f970315c5d6071f662d/rocketscraper-0.0.3.tar.gz",
    "platform": null,
    "description": "# Rocket Scraper API Python SDK\n\nPython SDK for the [Rocket Scraper API](https://rocketscraper.com). For more information, visit the [GitHub repository](https://github.com/rocketscraper/rocketscraper-sdk-python).\n\n## Requirements\n\n- [Python](https://www.python.org/) version 3.7 or above\n\n## Installation\n\n```bash\npip install rocketscraper\n```\n\n## Usage\n\nTo use the SDK, you need to create a new instance of the `RocketClient` class and pass your API key as an argument.\n\n### Setup\n\n```python\nfrom rocketscraper import RocketClient\n\nrocket_client = RocketClient(api_key='YOUR_API_KEY')\n```\n\n### Scrape\n\nThe `scrape` method allows you to scrape data from a website using a schema. The method returns the scraped data in the format specified in the schema.\n\n```python\ndata = rocket_client.scrape(\n    url='https://ycombinator.com/companies/pagerduty',\n    schema={\n        'company': 'string',\n        'image_url': 'string',\n        'founded_at': 'string',\n        'size': 'integer',\n        'location': 'string',\n        'short_description': 'string',\n        'long_description': 'string',\n        'is_active': 'boolean',\n        'founders': [\n            {\n                'name': 'string',\n                'role': 'string',\n            },\n        ],\n    }\n)\n\nprint(data)\n```\n\nFor more details, visit the [Python SDK GitHub repository](https://github.com/rocketscraper/rocketscraper-sdk-python).\n\n## Documentation\n\nFor more information on how to use the Rocket Scraper API, visit the [Rocket Scraper API documentation](https://docs.rocketscraper.com).\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/rocketscraper/rocketscraper-sdk-python/blob/main/LICENSE) file for more details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python SDK for the Rocket Scraper API.",
    "version": "0.0.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/rocketscraper/rocketscraper-sdk-python/issues",
        "Homepage": "https://rocketscraper.com",
        "Repository": "https://github.com/rocketscraper/rocketscraper-sdk-python"
    },
    "split_keywords": [
        "rocketscraper",
        " api",
        " web-scraping",
        " ai"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "118c15b5326fe6e605a819b22e14ab53e547275b3ed435db21772bdf6de4b7f1",
                "md5": "b87e0dc76fcc50e4a2e1944626b6a4d2",
                "sha256": "4b7ac1e6afaa3c1007807c4352b58ef6ad9b497ea70a6d00a5e757aa81aa0b59"
            },
            "downloads": -1,
            "filename": "rocketscraper-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b87e0dc76fcc50e4a2e1944626b6a4d2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3700,
            "upload_time": "2024-10-19T04:31:51",
            "upload_time_iso_8601": "2024-10-19T04:31:51.654204Z",
            "url": "https://files.pythonhosted.org/packages/11/8c/15b5326fe6e605a819b22e14ab53e547275b3ed435db21772bdf6de4b7f1/rocketscraper-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5cb85ddd1ed172e9262896459fd0c264ee22ca1b535d6f970315c5d6071f662d",
                "md5": "680e0547ac9e1a43f955ff5ec04facdf",
                "sha256": "9f2789d5164b9aff46798a54f1716188384b3ff3956c13ab6ae90ac343ce2bd0"
            },
            "downloads": -1,
            "filename": "rocketscraper-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "680e0547ac9e1a43f955ff5ec04facdf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3267,
            "upload_time": "2024-10-19T04:31:52",
            "upload_time_iso_8601": "2024-10-19T04:31:52.714104Z",
            "url": "https://files.pythonhosted.org/packages/5c/b8/5ddd1ed172e9262896459fd0c264ee22ca1b535d6f970315c5d6071f662d/rocketscraper-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-19 04:31:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rocketscraper",
    "github_project": "rocketscraper-sdk-python",
    "github_not_found": true,
    "lcname": "rocketscraper"
}