rd-to-md 0.0.3
Scrape reddit posts into a single markdown file
License: MIT
Requires Python: >=3.12.3

# Reddit to Markdown Scraper (rd2md)

This Python script uses PRAW (Python Reddit API Wrapper) to scrape interesting posts from a specified subreddit and save them in a formatted Markdown file. It also downloads and saves images associated with the posts.

## Features

- Scrapes hot posts from a specified subreddit
- Filters posts based on score and whether they're stickied
- Downloads and saves images from posts
- Formats post content, including comments, into a Markdown file
- Handles both text posts and image posts
- Can be used as a standalone script or imported as a module

## Prerequisites

- Python 3.12.3 or higher
- pip (Python package installer)

## Installation

You can install rd2md directly from PyPI:

```
pip install rd-to-md
```

## Setup

To use this script, you need to create a Reddit application to get the necessary credentials:

1. Log in to your Reddit account
2. Go to https://www.reddit.com/prefs/apps
3. Scroll down and click "create another app..."
4. Fill out the form:
   - Choose a name for your application
   - Select "script" as the app type
   - For "redirect uri", use http://localhost:8080
   - Add a description (optional)
5. Click "create app"

After creating the app, note down the following:
- client_id: The string under "personal use script"
- client_secret: The string next to "secret"

## Usage

### As a Command-Line Tool

After installation, you can run rd2md from the command line:

```
rd2md --client_id=YOUR_CLIENT_ID --client_secret=YOUR_CLIENT_SECRET [options]
```

Options:
- `--client_id`: Your Reddit API client ID (required if not set as an environment variable)
- `--client_secret`: Your Reddit API client secret (required if not set as an environment variable)
- `--user_agent`: User agent for Reddit API (default: "praw_bot")
- `--subreddit`: Subreddit to scrape (default: "LocalLLaMA")
- `--limit`: Number of posts to scrape (default: 3)

Example:
```
rd2md --client_id=YOUR_CLIENT_ID --client_secret=YOUR_CLIENT_SECRET --subreddit=ProgrammingHumor --limit=10
```

### As an Importable Module

You can also use rd2md as a module in your Python code:

```python
from rd2md import rd2md

# Scrape and save posts
filename, list_contents, list_images = rd2md(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
    subreddit_name="ProgrammingHumor",
    limit=10
)
```

### Using Environment Variables

Instead of passing the client ID and secret as arguments, you can set them as environment variables:

```
export REDDIT_CLIENT_ID=your_client_id
export REDDIT_CLIENT_SECRET=your_client_secret
```

Then you can run the script without these arguments:

```
python rd2md.py --subreddit=ProgrammingHumor --limit=10
```

## Output

The script creates a new directory named `{subreddit}_posts_{date}` in the current working directory. This directory contains:

- A Markdown file named `{current_time}.md` with the scraped post content
- An `images` subdirectory containing any downloaded images

![Alt text](https://raw.githubusercontent.com/JosefAlbers/rd2md/main/assets/example_output.png)

## LLM Integration

```python
# https://github.com/JosefAlbers/Phi-3-Vision-MLX

from phi_3_vision_mlx import generate
from pathlib import Path
import json

filename, contents, images = rd2md(post_url='https://www.reddit.com/r/LocalLLaMA/comments/1e7pdig/this_sums_up_my_experience_with_all_llm/')
prompt = 'Write an executive summary of above (max 200 words). The article should capture the diverse range of opinions and key points discussed in the thread, presenting a balanced view of the topic without quoting specific users or comments directly. Focus on organizing the information cohesively, highlighting major arguments, counterarguments, and any emerging consensus or unresolved issues within the community.'
prompts = [f'{s}\n\n{prompt}' for s in contents]
results = [generate(prompts[i], images[i], max_tokens=512, blind_model=False, quantize_model=False, verbose=False) for i in range(len(prompts))]
with open(Path(filename).with_suffix('.json'), 'w') as f:
    json.dump({'prompts':prompts, 'images':images, 'results':results}, f, indent=4)
```

<details><summary>Click to expand output</summary><pre>
The discussion revolves around the use of LLM (Language Learning Models) in software development, particularly focusing on the abstraction provided by Langchain. Opinions are divided, with some advocating for the convenience and ease of use Langchain offers, while others criticize it for being overly complex and hindering customization and understanding. The thread suggests that while Langchain may simplify certain tasks, it can also lead to a lack of control and flexibility, potentially resulting in technical debt. There is a consensus that understanding the underlying mechanisms is crucial, and that abstractions should be used judiciously to avoid over-complication. The thread also touches on the broader topic of software development practices, emphasizing the importance of clear, maintainable code and the potential pitfalls of over-reliance on abstractions. The community appears to be grappling with the balance between leveraging existing tools and maintaining the ability to adapt and innovate independently.

</pre></details><br>

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.