Repository files navigation

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.

• Introduction
• Features
• Requirements
• Installation
• Configuration
• Usage
• Contributing
• License

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.

• 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.

• Python 3.x
• PRAW (Python Reddit API Wrapper)
• PyGithub

1. Clone the GitHub repository:

   git clone https://github.com/ni5arga/RedditWikiBot.git

2. Install the required Python packages:

   pip install -r requirements.txt

Create a.env file in project root directory with the following credentials.

# Reddit API credentialsREDDIT_CLIENT_ID=your_reddit_client_idREDDIT_CLIENT_SECRET=your_reddit_client_secretREDDIT_USER_AGENT=your_reddit_user_agentREDDIT_USERNAME=your_reddit_usernameREDDIT_PASSWORD=your_reddit_password# GitHub credentialsGITHUB_TOKEN=your_github_tokenGITHUB_REPO_OWNER=REPO_OWNER_USERNAMEGITHUB_REPO_NAME=YOUR_REPO_NAME# Other configurationsSUBREDDIT_NAME=your_subreddit_nameMIRROR_CONFIG=TRUE/FALSE (Setting true will mirror config/ files too, recommended to keep false)

Replaceyour_reddit_client_id,your_reddit_client_secret,your_reddit_user_agent,your_reddit_username,your_reddit_password,your_github_token, andyour_subreddit_name with your actual credentials.

Run the following command to mirror subreddit wiki pages to the GitHub repository:

python RedditToGithub.py

Run the following command to mirror GitHub repository wiki pages to the subreddit:

python GithubToReddit.py

Feel free to contribute to the project by opening issues or submitting pull requests. Your feedback and contributions are highly appreciated!