ugcscraper-helper 0.1.0__tar.gz

ugcscraper_helper-0.1.0/LICENSE

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

ugcscraper_helper-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: ugcscraper-helper
+Version: 0.1.0
+Summary: A tiny Python client for the UGC Scraper Reddit API — scrape posts and comments into clean JSON without Reddit API keys or proxies.
+License: MIT
+Project-URL: Homepage, https://ugcscraper.com
+Project-URL: Documentation, https://ugcscraper.com/reddit-scraper-api
+Project-URL: Repository, https://github.com/builtbyish/ugc-scraper-python-helper
+Keywords: reddit,reddit-scraper,reddit-comment-scraper,web-scraping,praw-alternative
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25
+Dynamic: license-file
+
+# ugc-scraper-python-helper
+
+A lightweight **Reddit scraper Python** client for the [UGC Scraper](https://ugcscraper.com) API.
+Scrape any Reddit post and its full comment thread into clean, consistent JSON, with **no Reddit API
+keys**, no OAuth app, and no proxies to manage.
+
+It is a ~90-line wrapper over the [UGC Scraper Platform](https://ugcscraper.com) REST API. One key,
+one endpoint, the same JSON schema every time, so you can build your parser once.
+
+## Why
+
+Most ways to scrape Reddit break on the same things: the official API needs OAuth and caps listings
+at ~1,000 items, and DIY scrapers get IP-banned without a rotating proxy pool. UGC Scraper routes
+every request through a resilient fallback chain with automatic failover and bills only for
+successful posts. This helper is the smallest possible way to call it from Python.
+
+## Install
+
+```bash
+pip install requests   # the only dependency
+# then drop ugcscraper.py into your project, or:
+pip install .
+```
+
+## Usage
+
+```python
+from ugcscraper import UGCScraper
+
+client = UGCScraper("rps_live_your_key")          # get a free key at ugcscraper.com/dashboard
+
+# Scrape a post + its full comment thread into one JSON schema
+post = client.scrape("https://www.reddit.com/r/python/comments/abc123/")
+print(post["title"], post["score"], len(post["comments"]))
+
+# Read your durable scrape history (free, no quota)
+print(client.history(limit=20))
+print(client.latest("abc123"))          # re-fetch a stored post without spending quota
+print(client.usage())                   # tier, quota, remaining
+
+# Export the same data as CSV
+open("comments.csv", "w").write(client.latest_csv("abc123", rows="comments"))
+open("history.csv", "w").write(client.history_csv())
+```
+
+Errors surface as `UGCScraperError` with the API's `status_code` and `detail` (401 invalid key,
+429 rate limit, 502 all methods failed).
+
+## What you get back
+
+A flattened, LLM-friendly schema: `title`, `author`, `score`, `num_comments`, `permalink`,
+`image_url`, `thumbnail_url`, `body`, and `comments[]` (each with `author`, `body`, `score`, `id`,
+`parent_id`, `link_id`, `permalink`, `created_at`). Same shape no matter which engine fetched it.
+
+## Links
+
+- Platform: <https://ugcscraper.com>
+- API reference (endpoints, auth, examples): <https://ugcscraper.com/reddit-scraper-api>
+- Get an API key (free tier: 1,000 successful posts/mo): <https://ugcscraper.com/dashboard>
+- MCP server for Claude Desktop: `ugc-scraper-reddit-mcp`
+
+## License
+
+MIT

ugcscraper_helper-0.1.0/README.md

@@ -0,0 +1,64 @@
+# ugc-scraper-python-helper
+
+A lightweight **Reddit scraper Python** client for the [UGC Scraper](https://ugcscraper.com) API.
+Scrape any Reddit post and its full comment thread into clean, consistent JSON, with **no Reddit API
+keys**, no OAuth app, and no proxies to manage.
+
+It is a ~90-line wrapper over the [UGC Scraper Platform](https://ugcscraper.com) REST API. One key,
+one endpoint, the same JSON schema every time, so you can build your parser once.
+
+## Why
+
+Most ways to scrape Reddit break on the same things: the official API needs OAuth and caps listings
+at ~1,000 items, and DIY scrapers get IP-banned without a rotating proxy pool. UGC Scraper routes
+every request through a resilient fallback chain with automatic failover and bills only for
+successful posts. This helper is the smallest possible way to call it from Python.
+
+## Install
+
+```bash
+pip install requests   # the only dependency
+# then drop ugcscraper.py into your project, or:
+pip install .
+```
+
+## Usage
+
+```python
+from ugcscraper import UGCScraper
+
+client = UGCScraper("rps_live_your_key")          # get a free key at ugcscraper.com/dashboard
+
+# Scrape a post + its full comment thread into one JSON schema
+post = client.scrape("https://www.reddit.com/r/python/comments/abc123/")
+print(post["title"], post["score"], len(post["comments"]))
+
+# Read your durable scrape history (free, no quota)
+print(client.history(limit=20))
+print(client.latest("abc123"))          # re-fetch a stored post without spending quota
+print(client.usage())                   # tier, quota, remaining
+
+# Export the same data as CSV
+open("comments.csv", "w").write(client.latest_csv("abc123", rows="comments"))
+open("history.csv", "w").write(client.history_csv())
+```
+
+Errors surface as `UGCScraperError` with the API's `status_code` and `detail` (401 invalid key,
+429 rate limit, 502 all methods failed).
+
+## What you get back
+
+A flattened, LLM-friendly schema: `title`, `author`, `score`, `num_comments`, `permalink`,
+`image_url`, `thumbnail_url`, `body`, and `comments[]` (each with `author`, `body`, `score`, `id`,
+`parent_id`, `link_id`, `permalink`, `created_at`). Same shape no matter which engine fetched it.
+
+## Links
+
+- Platform: <https://ugcscraper.com>
+- API reference (endpoints, auth, examples): <https://ugcscraper.com/reddit-scraper-api>
+- Get an API key (free tier: 1,000 successful posts/mo): <https://ugcscraper.com/dashboard>
+- MCP server for Claude Desktop: `ugc-scraper-reddit-mcp`
+
+## License
+
+MIT

ugcscraper_helper-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ugcscraper-helper"
+version = "0.1.0"
+description = "A tiny Python client for the UGC Scraper Reddit API — scrape posts and comments into clean JSON without Reddit API keys or proxies."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+keywords = ["reddit", "reddit-scraper", "reddit-comment-scraper", "web-scraping", "praw-alternative"]
+dependencies = ["requests>=2.25"]
+
+[project.urls]
+Homepage = "https://ugcscraper.com"
+Documentation = "https://ugcscraper.com/reddit-scraper-api"
+Repository = "https://github.com/builtbyish/ugc-scraper-python-helper"
+
+[tool.setuptools]
+py-modules = ["ugcscraper"]

ugcscraper_helper-0.1.0/setup.cfg

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

ugcscraper_helper-0.1.0/ugcscraper.py

@@ -0,0 +1,91 @@
+"""A tiny Python client for the UGC Scraper Reddit API (https://ugcscraper.com).
+
+Scrape a Reddit post and its full comment thread into clean, consistent JSON with no Reddit API
+keys and no proxies. Depends only on `requests`.
+
+    from ugcscraper import UGCScraper
+
+    client = UGCScraper("rps_live_your_key")
+    post = client.scrape("https://www.reddit.com/r/python/comments/abc123/")
+    print(post["title"], len(post["comments"]))
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import requests
+
+__all__ = ["UGCScraper", "UGCScraperError"]
+__version__ = "0.1.0"
+
+DEFAULT_BASE_URL = "https://api.ugcscraper.com"
+
+
+class UGCScraperError(RuntimeError):
+    """Raised when the API returns a non-2xx response (401 auth, 429 rate limit, 502, ...)."""
+
+    def __init__(self, status_code: int, detail: str):
+        self.status_code = status_code
+        self.detail = detail
+        super().__init__(f"UGC Scraper API error {status_code}: {detail}")
+
+
+class UGCScraper:
+    """Thin wrapper over the UGC Scraper REST API. One key, one endpoint, clean JSON back."""
+
+    def __init__(self, api_key: str, base_url: str = DEFAULT_BASE_URL, timeout: int = 60):
+        if not api_key:
+            raise ValueError("api_key is required (get one at https://ugcscraper.com/dashboard)")
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._session = requests.Session()
+        self._session.headers.update({"Authorization": f"Bearer {api_key}"})
+
+    # -- core ----------------------------------------------------------------
+    def scrape(self, url: str) -> dict[str, Any]:
+        """Scrape a Reddit post URL (or bare post id) into one consistent JSON schema.
+
+        Counts against your monthly quota only on success. Raises UGCScraperError on failure.
+        """
+        return self._request("POST", "/v1/scrape", json={"url": url}).json()
+
+    # -- durable history -----------------------------------------------------
+    def history(self, post_id: str | None = None, limit: int = 50) -> dict[str, Any]:
+        """List durable snapshots you have already scraped (summaries). Reading history is free."""
+        params: dict[str, Any] = {"limit": limit}
+        if post_id:
+            params["post_id"] = post_id
+        return self._request("GET", "/v1/history", params=params).json()
+
+    def latest(self, post_id: str) -> dict[str, Any]:
+        """Re-fetch the most recent stored full post for a post id, without spending quota."""
+        return self._request("GET", f"/v1/history/{post_id}/latest").json()
+
+    def usage(self) -> dict[str, Any]:
+        """Your plan tier, monthly quota, usage, and remaining successful-post allowance."""
+        return self._request("GET", "/v1/usage").json()
+
+    # -- CSV export ----------------------------------------------------------
+    def history_csv(self, post_id: str | None = None, limit: int = 50) -> str:
+        """The same history as CSV text (one row per snapshot)."""
+        params: dict[str, Any] = {"limit": limit, "format": "csv"}
+        if post_id:
+            params["post_id"] = post_id
+        return self._request("GET", "/v1/history", params=params).text
+
+    def latest_csv(self, post_id: str, rows: str = "comments") -> str:
+        """A stored post as CSV text: rows='comments' (one row per comment) or rows='post'."""
+        params = {"format": "csv", "rows": rows}
+        return self._request("GET", f"/v1/history/{post_id}/latest", params=params).text
+
+    # -- internal ------------------------------------------------------------
+    def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
+        resp = self._session.request(method, self.base_url + path, timeout=self.timeout, **kwargs)
+        if not resp.ok:
+            try:
+                detail = resp.json().get("detail", resp.text)
+            except ValueError:
+                detail = resp.text
+            raise UGCScraperError(resp.status_code, str(detail))
+        return resp

ugcscraper_helper-0.1.0/ugcscraper_helper.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: ugcscraper-helper
+Version: 0.1.0
+Summary: A tiny Python client for the UGC Scraper Reddit API — scrape posts and comments into clean JSON without Reddit API keys or proxies.
+License: MIT
+Project-URL: Homepage, https://ugcscraper.com
+Project-URL: Documentation, https://ugcscraper.com/reddit-scraper-api
+Project-URL: Repository, https://github.com/builtbyish/ugc-scraper-python-helper
+Keywords: reddit,reddit-scraper,reddit-comment-scraper,web-scraping,praw-alternative
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25
+Dynamic: license-file
+
+# ugc-scraper-python-helper
+
+A lightweight **Reddit scraper Python** client for the [UGC Scraper](https://ugcscraper.com) API.
+Scrape any Reddit post and its full comment thread into clean, consistent JSON, with **no Reddit API
+keys**, no OAuth app, and no proxies to manage.
+
+It is a ~90-line wrapper over the [UGC Scraper Platform](https://ugcscraper.com) REST API. One key,
+one endpoint, the same JSON schema every time, so you can build your parser once.
+
+## Why
+
+Most ways to scrape Reddit break on the same things: the official API needs OAuth and caps listings
+at ~1,000 items, and DIY scrapers get IP-banned without a rotating proxy pool. UGC Scraper routes
+every request through a resilient fallback chain with automatic failover and bills only for
+successful posts. This helper is the smallest possible way to call it from Python.
+
+## Install
+
+```bash
+pip install requests   # the only dependency
+# then drop ugcscraper.py into your project, or:
+pip install .
+```
+
+## Usage
+
+```python
+from ugcscraper import UGCScraper
+
+client = UGCScraper("rps_live_your_key")          # get a free key at ugcscraper.com/dashboard
+
+# Scrape a post + its full comment thread into one JSON schema
+post = client.scrape("https://www.reddit.com/r/python/comments/abc123/")
+print(post["title"], post["score"], len(post["comments"]))
+
+# Read your durable scrape history (free, no quota)
+print(client.history(limit=20))
+print(client.latest("abc123"))          # re-fetch a stored post without spending quota
+print(client.usage())                   # tier, quota, remaining
+
+# Export the same data as CSV
+open("comments.csv", "w").write(client.latest_csv("abc123", rows="comments"))
+open("history.csv", "w").write(client.history_csv())
+```
+
+Errors surface as `UGCScraperError` with the API's `status_code` and `detail` (401 invalid key,
+429 rate limit, 502 all methods failed).
+
+## What you get back
+
+A flattened, LLM-friendly schema: `title`, `author`, `score`, `num_comments`, `permalink`,
+`image_url`, `thumbnail_url`, `body`, and `comments[]` (each with `author`, `body`, `score`, `id`,
+`parent_id`, `link_id`, `permalink`, `created_at`). Same shape no matter which engine fetched it.
+
+## Links
+
+- Platform: <https://ugcscraper.com>
+- API reference (endpoints, auth, examples): <https://ugcscraper.com/reddit-scraper-api>
+- Get an API key (free tier: 1,000 successful posts/mo): <https://ugcscraper.com/dashboard>
+- MCP server for Claude Desktop: `ugc-scraper-reddit-mcp`
+
+## License
+
+MIT

ugcscraper_helper-0.1.0/ugcscraper_helper.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+ugcscraper.py
+ugcscraper_helper.egg-info/PKG-INFO
+ugcscraper_helper.egg-info/SOURCES.txt
+ugcscraper_helper.egg-info/dependency_links.txt
+ugcscraper_helper.egg-info/requires.txt
+ugcscraper_helper.egg-info/top_level.txt

ugcscraper_helper-0.1.0/ugcscraper_helper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ugcscraper_helper-0.1.0/ugcscraper_helper.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25

ugcscraper_helper-0.1.0/ugcscraper_helper.egg-info/top_level.txt

@@ -0,0 +1 @@
+ugcscraper