mcp-reddit 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,35 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+ workflow_dispatch:
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ publish:
13
+ runs-on: ubuntu-latest
14
+
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - name: Set up Python
19
+ uses: actions/setup-python@v5
20
+ with:
21
+ python-version: "3.11"
22
+
23
+ - name: Install build dependencies
24
+ run: |
25
+ python -m pip install --upgrade pip
26
+ pip install build twine
27
+
28
+ - name: Build package
29
+ run: python -m build
30
+
31
+ - name: Publish to PyPI
32
+ env:
33
+ TWINE_USERNAME: __token__
34
+ TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
35
+ run: twine upload dist/*
@@ -0,0 +1,46 @@
1
+ # Claude Code
2
+ .claude/settings.local.json
3
+ logs/
4
+
5
+ # Dependencies
6
+ node_modules/
7
+ vendor/
8
+ .venv/
9
+ venv/
10
+ __pycache__/
11
+ *.pyc
12
+
13
+ # Build outputs
14
+ dist/
15
+ build/
16
+ .next/
17
+ out/
18
+ *.egg-info/
19
+
20
+ # Environment
21
+ .env
22
+ .env.local
23
+ .env.*.local
24
+ !.env.example
25
+
26
+ # IDE
27
+ .idea/
28
+ .vscode/
29
+ *.swp
30
+ *.swo
31
+ .DS_Store
32
+
33
+ # Testing
34
+ coverage/
35
+ .nyc_output/
36
+ .pytest_cache/
37
+
38
+ # Logs
39
+ *.log
40
+ npm-debug.log*
41
+ yarn-debug.log*
42
+ yarn-error.log*
43
+ data/
44
+ .claude/
45
+ .mcp.json
46
+ CLAUDE.md
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,150 @@
1
+ Metadata-Version: 2.4
2
+ Name: mcp-reddit
3
+ Version: 0.1.0
4
+ Summary: MCP server for scraping Reddit - no API keys required
5
+ Project-URL: Homepage, https://github.com/yourusername/mcp-reddit
6
+ Project-URL: Repository, https://github.com/yourusername/mcp-reddit
7
+ Project-URL: Issues, https://github.com/yourusername/mcp-reddit/issues
8
+ Author: Naman
9
+ License-Expression: MIT
10
+ License-File: LICENSE
11
+ Keywords: anthropic,claude,mcp,reddit,scraper
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Requires-Python: >=3.10
20
+ Requires-Dist: aiofiles>=23.0.0
21
+ Requires-Dist: aiohttp>=3.9.0
22
+ Requires-Dist: mcp>=1.0.0
23
+ Requires-Dist: pandas>=2.0.0
24
+ Provides-Extra: dev
25
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
26
+ Requires-Dist: pytest>=7.0.0; extra == 'dev'
27
+ Description-Content-Type: text/markdown
28
+
29
+ # mcp-reddit
30
+
31
+ MCP server for scraping Reddit - **no API keys required**.
32
+
33
+ Scrapes posts, comments, and media from subreddits and user profiles using old.reddit.com and Libreddit mirrors.
34
+
35
+ ## Features
36
+
37
+ - **No API keys** - Scrapes directly, no Reddit API credentials needed
38
+ - **Media downloads** - Images, videos with audio (requires ffmpeg)
39
+ - **Local persistence** - Query scraped data offline
40
+ - **Rich filtering** - By post type, score, keywords
41
+ - **Comments included** - Full thread scraping
42
+
43
+ ## Installation
44
+
45
+ ```bash
46
+ pip install mcp-reddit
47
+ ```
48
+
49
+ Or with uvx:
50
+
51
+ ```bash
52
+ uvx mcp-reddit
53
+ ```
54
+
55
+ ## Configuration
56
+
57
+ Add to your Claude Desktop or Claude Code settings:
58
+
59
+ ### Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`)
60
+
61
+ ```json
62
+ {
63
+ "mcpServers": {
64
+ "reddit": {
65
+ "command": "uvx",
66
+ "args": ["mcp-reddit"]
67
+ }
68
+ }
69
+ }
70
+ ```
71
+
72
+ ### Claude Code (`~/.claude/settings.json`)
73
+
74
+ ```json
75
+ {
76
+ "mcpServers": {
77
+ "reddit": {
78
+ "command": "uvx",
79
+ "args": ["mcp-reddit"]
80
+ }
81
+ }
82
+ }
83
+ ```
84
+
85
+ ## Available Tools
86
+
87
+ | Tool | Description |
88
+ | ---------------------- | ---------------------------------- |
89
+ | `scrape_subreddit` | Scrape posts from a subreddit |
90
+ | `scrape_user` | Scrape posts from a user's profile |
91
+ | `get_posts` | Query stored posts with filters |
92
+ | `get_comments` | Query stored comments |
93
+ | `search_reddit` | Search across all scraped data |
94
+ | `get_top_posts` | Get highest scoring posts |
95
+ | `list_scraped_sources` | List all scraped subreddits/users |
96
+
97
+ ## Example Usage
98
+
99
+ ```
100
+ "Scrape the top 50 posts from r/LocalLLaMA"
101
+
102
+ "Search my scraped data for posts about 'fine-tuning'"
103
+
104
+ "Get the top 10 posts from r/ClaudeAI by score"
105
+ ```
106
+
107
+ ## Data Storage
108
+
109
+ Data is stored in `~/.mcp-reddit/data/` by default.
110
+
111
+ Set `MCP_REDDIT_DATA_DIR` environment variable to customize:
112
+
113
+ ```json
114
+ {
115
+ "mcpServers": {
116
+ "reddit": {
117
+ "command": "uvx",
118
+ "args": ["mcp-reddit"],
119
+ "env": {
120
+ "MCP_REDDIT_DATA_DIR": "/path/to/your/data"
121
+ }
122
+ }
123
+ }
124
+ }
125
+ ```
126
+
127
+ ## Optional: Video with Audio
128
+
129
+ To download Reddit videos with audio, install ffmpeg:
130
+
131
+ ```bash
132
+ # macOS
133
+ brew install ffmpeg
134
+
135
+ # Ubuntu/Debian
136
+ sudo apt install ffmpeg
137
+
138
+ # Windows
139
+ choco install ffmpeg
140
+ ```
141
+
142
+ ## Credits
143
+
144
+ Built on top of [reddit-universal-scraper](https://github.com/ksanjeev284/reddit-universal-scraper)
145
+ by [@ksanjeev284](https://github.com/ksanjeev284) - a full-featured Reddit scraper with
146
+ analytics dashboard, REST API, and plugin system.
147
+
148
+ ## License
149
+
150
+ MIT
@@ -0,0 +1,122 @@
1
+ # mcp-reddit
2
+
3
+ MCP server for scraping Reddit - **no API keys required**.
4
+
5
+ Scrapes posts, comments, and media from subreddits and user profiles using old.reddit.com and Libreddit mirrors.
6
+
7
+ ## Features
8
+
9
+ - **No API keys** - Scrapes directly, no Reddit API credentials needed
10
+ - **Media downloads** - Images, videos with audio (requires ffmpeg)
11
+ - **Local persistence** - Query scraped data offline
12
+ - **Rich filtering** - By post type, score, keywords
13
+ - **Comments included** - Full thread scraping
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ pip install mcp-reddit
19
+ ```
20
+
21
+ Or with uvx:
22
+
23
+ ```bash
24
+ uvx mcp-reddit
25
+ ```
26
+
27
+ ## Configuration
28
+
29
+ Add to your Claude Desktop or Claude Code settings:
30
+
31
+ ### Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`)
32
+
33
+ ```json
34
+ {
35
+ "mcpServers": {
36
+ "reddit": {
37
+ "command": "uvx",
38
+ "args": ["mcp-reddit"]
39
+ }
40
+ }
41
+ }
42
+ ```
43
+
44
+ ### Claude Code (`~/.claude/settings.json`)
45
+
46
+ ```json
47
+ {
48
+ "mcpServers": {
49
+ "reddit": {
50
+ "command": "uvx",
51
+ "args": ["mcp-reddit"]
52
+ }
53
+ }
54
+ }
55
+ ```
56
+
57
+ ## Available Tools
58
+
59
+ | Tool | Description |
60
+ | ---------------------- | ---------------------------------- |
61
+ | `scrape_subreddit` | Scrape posts from a subreddit |
62
+ | `scrape_user` | Scrape posts from a user's profile |
63
+ | `get_posts` | Query stored posts with filters |
64
+ | `get_comments` | Query stored comments |
65
+ | `search_reddit` | Search across all scraped data |
66
+ | `get_top_posts` | Get highest scoring posts |
67
+ | `list_scraped_sources` | List all scraped subreddits/users |
68
+
69
+ ## Example Usage
70
+
71
+ ```
72
+ "Scrape the top 50 posts from r/LocalLLaMA"
73
+
74
+ "Search my scraped data for posts about 'fine-tuning'"
75
+
76
+ "Get the top 10 posts from r/ClaudeAI by score"
77
+ ```
78
+
79
+ ## Data Storage
80
+
81
+ Data is stored in `~/.mcp-reddit/data/` by default.
82
+
83
+ Set `MCP_REDDIT_DATA_DIR` environment variable to customize:
84
+
85
+ ```json
86
+ {
87
+ "mcpServers": {
88
+ "reddit": {
89
+ "command": "uvx",
90
+ "args": ["mcp-reddit"],
91
+ "env": {
92
+ "MCP_REDDIT_DATA_DIR": "/path/to/your/data"
93
+ }
94
+ }
95
+ }
96
+ }
97
+ ```
98
+
99
+ ## Optional: Video with Audio
100
+
101
+ To download Reddit videos with audio, install ffmpeg:
102
+
103
+ ```bash
104
+ # macOS
105
+ brew install ffmpeg
106
+
107
+ # Ubuntu/Debian
108
+ sudo apt install ffmpeg
109
+
110
+ # Windows
111
+ choco install ffmpeg
112
+ ```
113
+
114
+ ## Credits
115
+
116
+ Built on top of [reddit-universal-scraper](https://github.com/ksanjeev284/reddit-universal-scraper)
117
+ by [@ksanjeev284](https://github.com/ksanjeev284) - a full-featured Reddit scraper with
118
+ analytics dashboard, REST API, and plugin system.
119
+
120
+ ## License
121
+
122
+ MIT
@@ -0,0 +1,30 @@
1
+ # mcp-reddit Development Worklog
2
+
3
+ **RULES:**
4
+ - **ONLY append new entries to the TOP** - never edit or delete older entries
5
+ - **Run `date -u +"%Y-%m-%d %H:%M:%S UTC"` to get the timestamp** - do NOT guess
6
+
7
+ ## 2025-12-28 07:40:07 UTC
8
+
9
+ **Activity**: Created open-source MCP Reddit package
10
+ **What**: Built standalone MCP server for Reddit scraping, ready for PyPI
11
+ **Details**:
12
+ - Researched existing Reddit MCPs (Hawstein, Arindam) - ours has unique features (media download, local persistence, no API keys)
13
+ - Followed Anthropic's 3-tier distribution model (PyPI → MCP Registry → Anthropic Directory)
14
+ - Created src/mcp_reddit/ with server.py (7 tools with annotations) and scraper.py (async)
15
+ - Added pyproject.toml, server.json, README with credits to @ksanjeev284
16
+ - Installed Python 3.12 via Homebrew, tested package installation
17
+ - Verified all MCP tools work (list_scraped_sources, get_top_posts, search_reddit, etc.)
18
+ - Initialized git repo, committed initial package
19
+ **Next**: Push to GitHub, add PYPI_TOKEN secret, create release to publish
20
+
21
+ ---
22
+
23
+ ## 2025-12-28 06:56:59 UTC
24
+
25
+ **Activity**: Project setup
26
+ **What**: Initialized Claude Code configuration
27
+ **Details**: Added CLAUDE.md, hooks, skills, output styles, worklog
28
+ **Next**: Start development
29
+
30
+ ---
@@ -0,0 +1,47 @@
1
+ [project]
2
+ name = "mcp-reddit"
3
+ version = "0.1.0"
4
+ description = "MCP server for scraping Reddit - no API keys required"
5
+ readme = "README.md"
6
+ license = "MIT"
7
+ requires-python = ">=3.10"
8
+ authors = [
9
+ { name = "Naman" }
10
+ ]
11
+ keywords = ["mcp", "reddit", "scraper", "claude", "anthropic"]
12
+ classifiers = [
13
+ "Development Status :: 4 - Beta",
14
+ "Intended Audience :: Developers",
15
+ "License :: OSI Approved :: MIT License",
16
+ "Programming Language :: Python :: 3",
17
+ "Programming Language :: Python :: 3.10",
18
+ "Programming Language :: Python :: 3.11",
19
+ "Programming Language :: Python :: 3.12",
20
+ ]
21
+ dependencies = [
22
+ "mcp>=1.0.0",
23
+ "pandas>=2.0.0",
24
+ "aiohttp>=3.9.0",
25
+ "aiofiles>=23.0.0",
26
+ ]
27
+
28
+ [project.optional-dependencies]
29
+ dev = [
30
+ "pytest>=7.0.0",
31
+ "pytest-asyncio>=0.21.0",
32
+ ]
33
+
34
+ [project.scripts]
35
+ mcp-reddit = "mcp_reddit.server:main"
36
+
37
+ [project.urls]
38
+ Homepage = "https://github.com/yourusername/mcp-reddit"
39
+ Repository = "https://github.com/yourusername/mcp-reddit"
40
+ Issues = "https://github.com/yourusername/mcp-reddit/issues"
41
+
42
+ [build-system]
43
+ requires = ["hatchling"]
44
+ build-backend = "hatchling.build"
45
+
46
+ [tool.hatch.build.targets.wheel]
47
+ packages = ["src/mcp_reddit"]
@@ -0,0 +1,42 @@
1
+ {
2
+ "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json",
3
+ "name": "io.github.yourusername/mcp-reddit",
4
+ "description": "Scrape Reddit without API keys - posts, comments, media from subreddits and users",
5
+ "version": "0.1.0",
6
+ "packages": [
7
+ {
8
+ "registry_type": "pypi",
9
+ "identifier": "mcp-reddit"
10
+ }
11
+ ],
12
+ "tools": [
13
+ {
14
+ "name": "scrape_subreddit",
15
+ "description": "Scrape posts from a subreddit"
16
+ },
17
+ {
18
+ "name": "scrape_user",
19
+ "description": "Scrape posts from a user's profile"
20
+ },
21
+ {
22
+ "name": "get_posts",
23
+ "description": "Query stored posts with filters"
24
+ },
25
+ {
26
+ "name": "get_comments",
27
+ "description": "Query stored comments"
28
+ },
29
+ {
30
+ "name": "search_reddit",
31
+ "description": "Search across all scraped data"
32
+ },
33
+ {
34
+ "name": "get_top_posts",
35
+ "description": "Get highest scoring posts"
36
+ },
37
+ {
38
+ "name": "list_scraped_sources",
39
+ "description": "List all scraped subreddits/users"
40
+ }
41
+ ]
42
+ }
@@ -0,0 +1,10 @@
1
+ """
2
+ MCP Reddit - Scrape Reddit without API keys
3
+ Based on reddit-universal-scraper by @ksanjeev284
4
+ https://github.com/ksanjeev284/reddit-universal-scraper
5
+ """
6
+ from .server import main
7
+ from .scraper import run_scraper, scrape_async
8
+
9
+ __version__ = "0.1.0"
10
+ __all__ = ["main", "run_scraper", "scrape_async"]