scrapingbee-cli 1.0.0__tar.gz

scrapingbee_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ScrapingBee
+
+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.

scrapingbee_cli-1.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: scrapingbee-cli
+Version: 1.0.0
+Summary: Command-line client for the ScrapingBee API: scrape pages (single or batch), crawl sites, check usage/credits, and use Google Search, Fast Search, Amazon, Walmart, YouTube, and ChatGPT from the terminal.
+Author: ScrapingBee
+License-Expression: MIT
+Project-URL: Homepage, https://www.scrapingbee.com/
+Project-URL: Documentation, https://www.scrapingbee.com/documentation/
+Project-URL: Repository, https://github.com/ScrapingBee/scrapingbee-cli
+Keywords: scrapingbee,scraping,crawl,scrapy,batch,google-search,amazon,walmart,youtube,chatgpt,cli,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: click>=8.0
+Requires-Dist: click-option-group>=0.5.6
+Requires-Dist: scrapy>=2.11
+Requires-Dist: scrapy-scrapingbee>=0.0.5
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-cov>=4; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: ty>=0.0.17; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# ScrapingBee CLI
+
+Command-line client for the [ScrapingBee](https://www.scrapingbee.com/) API: scrape URLs (single or batch), crawl sites, check usage and credits, and use Google, Fast Search, Amazon, Walmart, YouTube, and ChatGPT from the terminal.
+
+## Requirements
+
+- **Python 3.10+**
+
+## Installation
+
+```bash
+pip install scrapingbee-cli
+# or (isolated): pipx install scrapingbee-cli
+```
+
+From source: clone the repo and run `pip install -e .` in the project root.
+
+## Configuration
+
+You need a ScrapingBee API key:
+
+1. **`scrapingbee auth`** – Save the key to config (use `--api-key KEY` for non-interactive; `--show` to print config path).
+2. **Environment** – `export SCRAPINGBEE_API_KEY=your_key`
+3. **`.env` file** – In the current directory or `~/.config/scrapingbee-cli/.env`
+
+Remove the stored key with `scrapingbee logout`. Get your API key from the [ScrapingBee dashboard](https://app.scrapingbee.com/).
+
+## Usage
+
+```bash
+scrapingbee [command] [arguments] [options]
+```
+
+- **`scrapingbee --help`** – List all commands.
+- **`scrapingbee [command] --help`** – Options and parameters for that command.
+
+**Global flags** (must appear before the subcommand): `--output-file`, `--verbose`, `--output-dir`, `--input-file`, `--concurrency`, `--retries`, `--backoff`. For details, run `scrapingbee --help` or see the [documentation](https://www.scrapingbee.com/documentation/).
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `usage` | Check credits and max concurrency |
+| `auth` / `logout` | Save or remove API key |
+| `docs` | Print docs URL; `--open` to open in browser |
+| `scrape [url]` | Scrape a URL (HTML, JS, screenshot, extract) |
+| `crawl` | Crawl with Scrapy or from URL(s) |
+| `google` / `fast-search` | Search SERP APIs |
+| `amazon-product` / `amazon-search` | Amazon product and search |
+| `walmart-search` / `walmart-product` | Walmart search and product |
+| `youtube-search` / `youtube-metadata` | YouTube search and video metadata |
+| `chatgpt` | ChatGPT API |
+
+**Batch mode:** Commands that take a single input support `--input-file` (one line per input) and `--output-dir`. Run `scrapingbee usage` before large batches.
+
+**Parameters and options:** Use space-separated values (e.g. `--render-js false`), not `--option=value`. For full parameter lists, response formats, and credit costs, see **`scrapingbee [command] --help`** and the [ScrapingBee API documentation](https://www.scrapingbee.com/documentation/).
+
+### Examples
+
+```bash
+scrapingbee usage
+scrapingbee docs --open
+scrapingbee --output-file page.html scrape "https://example.com"
+scrapingbee --output-dir out --input-file urls.txt scrape
+scrapingbee --output-file serp.json google "pizza new york"
+```
+
+## More information
+
+- **[ScrapingBee API documentation](https://www.scrapingbee.com/documentation/)** – Parameters, response formats, credit costs, and best practices.
+- **Claude / AI agents:** This repo includes a [Claude Skill](https://github.com/ScrapingBee/scrapingbee-cli/tree/main/skills/scrapingbee-cli) and [Claude Plugin](.claude-plugin/) for agent use with file-based output and security rules.
+
+## Testing
+
+Pytest is configured in `pyproject.toml` (`[tool.pytest.ini_options]`). From the project root:
+
+**1. Install the package with dev dependencies**
+
+```bash
+pip install -e ".[dev]"
+```
+
+**2. Run tests**
+
+| Command | What runs |
+|---------|------------|
+| `pytest` | Full suite (integration tests require `SCRAPINGBEE_API_KEY`) |
+| `pytest tests/unit` | Unit tests only (no API key needed) |
+| `pytest -m "not integration"` | All except integration (no API key needed) |
+| `pytest -v` | Same as above with verbose output (default in config) |
+
+Integration tests call the live ScrapingBee API and are marked with `@pytest.mark.integration`.

scrapingbee_cli-1.0.0/README.md

@@ -0,0 +1,92 @@
+# ScrapingBee CLI
+
+Command-line client for the [ScrapingBee](https://www.scrapingbee.com/) API: scrape URLs (single or batch), crawl sites, check usage and credits, and use Google, Fast Search, Amazon, Walmart, YouTube, and ChatGPT from the terminal.
+
+## Requirements
+
+- **Python 3.10+**
+
+## Installation
+
+```bash
+pip install scrapingbee-cli
+# or (isolated): pipx install scrapingbee-cli
+```
+
+From source: clone the repo and run `pip install -e .` in the project root.
+
+## Configuration
+
+You need a ScrapingBee API key:
+
+1. **`scrapingbee auth`** – Save the key to config (use `--api-key KEY` for non-interactive; `--show` to print config path).
+2. **Environment** – `export SCRAPINGBEE_API_KEY=your_key`
+3. **`.env` file** – In the current directory or `~/.config/scrapingbee-cli/.env`
+
+Remove the stored key with `scrapingbee logout`. Get your API key from the [ScrapingBee dashboard](https://app.scrapingbee.com/).
+
+## Usage
+
+```bash
+scrapingbee [command] [arguments] [options]
+```
+
+- **`scrapingbee --help`** – List all commands.
+- **`scrapingbee [command] --help`** – Options and parameters for that command.
+
+**Global flags** (must appear before the subcommand): `--output-file`, `--verbose`, `--output-dir`, `--input-file`, `--concurrency`, `--retries`, `--backoff`. For details, run `scrapingbee --help` or see the [documentation](https://www.scrapingbee.com/documentation/).
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `usage` | Check credits and max concurrency |
+| `auth` / `logout` | Save or remove API key |
+| `docs` | Print docs URL; `--open` to open in browser |
+| `scrape [url]` | Scrape a URL (HTML, JS, screenshot, extract) |
+| `crawl` | Crawl with Scrapy or from URL(s) |
+| `google` / `fast-search` | Search SERP APIs |
+| `amazon-product` / `amazon-search` | Amazon product and search |
+| `walmart-search` / `walmart-product` | Walmart search and product |
+| `youtube-search` / `youtube-metadata` | YouTube search and video metadata |
+| `chatgpt` | ChatGPT API |
+
+**Batch mode:** Commands that take a single input support `--input-file` (one line per input) and `--output-dir`. Run `scrapingbee usage` before large batches.
+
+**Parameters and options:** Use space-separated values (e.g. `--render-js false`), not `--option=value`. For full parameter lists, response formats, and credit costs, see **`scrapingbee [command] --help`** and the [ScrapingBee API documentation](https://www.scrapingbee.com/documentation/).
+
+### Examples
+
+```bash
+scrapingbee usage
+scrapingbee docs --open
+scrapingbee --output-file page.html scrape "https://example.com"
+scrapingbee --output-dir out --input-file urls.txt scrape
+scrapingbee --output-file serp.json google "pizza new york"
+```
+
+## More information
+
+- **[ScrapingBee API documentation](https://www.scrapingbee.com/documentation/)** – Parameters, response formats, credit costs, and best practices.
+- **Claude / AI agents:** This repo includes a [Claude Skill](https://github.com/ScrapingBee/scrapingbee-cli/tree/main/skills/scrapingbee-cli) and [Claude Plugin](.claude-plugin/) for agent use with file-based output and security rules.
+
+## Testing
+
+Pytest is configured in `pyproject.toml` (`[tool.pytest.ini_options]`). From the project root:
+
+**1. Install the package with dev dependencies**
+
+```bash
+pip install -e ".[dev]"
+```
+
+**2. Run tests**
+
+| Command | What runs |
+|---------|------------|
+| `pytest` | Full suite (integration tests require `SCRAPINGBEE_API_KEY`) |
+| `pytest tests/unit` | Unit tests only (no API key needed) |
+| `pytest -m "not integration"` | All except integration (no API key needed) |
+| `pytest -v` | Same as above with verbose output (default in config) |
+
+Integration tests call the live ScrapingBee API and are marked with `@pytest.mark.integration`.

scrapingbee_cli-1.0.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scrapingbee-cli"
+version = "1.0.0"
+description = "Command-line client for the ScrapingBee API: scrape pages (single or batch), crawl sites, check usage/credits, and use Google Search, Fast Search, Amazon, Walmart, YouTube, and ChatGPT from the terminal."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "ScrapingBee" }]
+keywords = [
+    "scrapingbee",
+    "scraping",
+    "crawl",
+    "scrapy",
+    "batch",
+    "google-search",
+    "amazon",
+    "walmart",
+    "youtube",
+    "chatgpt",
+    "cli",
+    "api",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+]
+dependencies = [
+    "aiohttp>=3.9",
+    "click>=8.0",
+    "click-option-group>=0.5.6",
+    "scrapy>=2.11",
+    "scrapy-scrapingbee>=0.0.5",
+]
+
+[project.urls]
+Homepage = "https://www.scrapingbee.com/"
+Documentation = "https://www.scrapingbee.com/documentation/"
+Repository = "https://github.com/ScrapingBee/scrapingbee-cli"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7",
+    "pytest-cov>=4",
+    "ruff>=0.8",
+    "ty>=0.0.17",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+scrapingbee = "scrapingbee_cli.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.ty]
+[tool.ty.environment]
+python-version = "3.10"
+[tool.ty.src]
+include = ["src", "tests"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+markers = [
+    "integration: marks tests that call the live API (deselect with '-m \"not integration\"')",
+]
+addopts = "-v --tb=short"

scrapingbee_cli-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

scrapingbee_cli-1.0.0/src/scrapingbee_cli/__init__.py

@@ -0,0 +1,3 @@
+"""ScrapingBee CLI - Command-line client for the ScrapingBee API."""
+
+__version__ = "1.0.0"