Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ni5arga/redditwikibot
RedditWikiBot is a bot that facilitates the synchronization of Reddit wiki pages with a GitHub repository and vice versa. It mirrors subreddit wiki pages to your GitHub repository and can also mirror them back to the subreddit pages if they are updated or changed in the GitHub repository.
https://github.com/ni5arga/redditwikibot
mirror moderation praw reddit reddit-api reddit-wiki subreddit subreddit-wiki subreddits wiki
Last synced: 2 months ago
JSON representation
RedditWikiBot is a bot that facilitates the synchronization of Reddit wiki pages with a GitHub repository and vice versa. It mirrors subreddit wiki pages to your GitHub repository and can also mirror them back to the subreddit pages if they are updated or changed in the GitHub repository.
- Host: GitHub
- URL: https://github.com/ni5arga/redditwikibot
- Owner: ni5arga
- License: mit
- Created: 2024-01-05T04:38:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-05T04:53:12.000Z (about 1 year ago)
- Last Synced: 2024-05-01T13:37:32.772Z (8 months ago)
- Topics: mirror, moderation, praw, reddit, reddit-api, reddit-wiki, subreddit, subreddit-wiki, subreddits, wiki
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RedditWikiBot
RedditWikiBot is a bot that facilitates the synchronization of Reddit wiki pages with a GitHub repository and vice versa.
It is a Reddit bot written in Python which mirrors subreddit wiki pages to your GitHub repository and can also mirror them back to the subreddit pages if they are updated or changed in the GitHub repository.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Introduction
RedditWikiBot consists of two main scripts:
- **RedditToGithub.py**: Mirrors subreddit wiki pages to a specified GitHub repository.
- **GithubToReddit.py**: Mirrors GitHub repository wiki pages to a specified subreddit.
## Features
- Bidirectional synchronization of wiki pages between Reddit and GitHub.
- Customizable configuration to skip certain pages or directories.
- Error handling for various scenarios, such as missing files or network issues.
## Requirements
- Python 3.x
- PRAW (Python Reddit API Wrapper)
- PyGithub
## Installation
1. Clone the GitHub repository:
```bash
git clone https://github.com/ni5arga/RedditWikiBot.git
```
2. Install the required Python packages:
```bash
pip install -r requirements.txt
```
## Configuration
Create a `.env` file in project root directory with the following credentials.
```env
# Reddit API credentials
REDDIT_CLIENT_ID=your_reddit_client_id
REDDIT_CLIENT_SECRET=your_reddit_client_secret
REDDIT_USER_AGENT=your_reddit_user_agent
REDDIT_USERNAME=your_reddit_username
REDDIT_PASSWORD=your_reddit_password
# GitHub credentials
GITHUB_TOKEN=your_github_token
GITHUB_REPO_OWNER=REPO_OWNER_USERNAME
GITHUB_REPO_NAME=YOUR_REPO_NAME
# Other configurations
SUBREDDIT_NAME=your_subreddit_name
MIRROR_CONFIG=TRUE/FALSE (Setting true will mirror config/ files too, recommended to keep false)
```
Replace `your_reddit_client_id`, `your_reddit_client_secret`, `your_reddit_user_agent`, `your_reddit_username`, `your_reddit_password`, `your_github_token`, and `your_subreddit_name` with your actual credentials.
## Usage
### RedditToGitHub.py
Run the following command to mirror subreddit wiki pages to the GitHub repository:
```bash
python RedditToGithub.py
```
### GithubToReddit.py
Run the following command to mirror GitHub repository wiki pages to the subreddit:
```bash
python GithubToReddit.py
```
## Contributing
Feel free to contribute to the project by opening issues or submitting pull requests. Your feedback and contributions are highly appreciated!