{"id":18708224,"url":"https://github.com/ni5arga/redditwikibot","last_synced_at":"2025-04-12T10:33:58.339Z","repository":{"id":215559465,"uuid":"739232703","full_name":"ni5arga/RedditWikiBot","owner":"ni5arga","description":"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.","archived":false,"fork":false,"pushed_at":"2024-01-05T04:53:12.000Z","size":11,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T13:37:32.772Z","etag":null,"topics":["mirror","moderation","praw","reddit","reddit-api","reddit-wiki","subreddit","subreddit-wiki","subreddits","wiki"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ni5arga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-05T04:38:45.000Z","updated_at":"2024-02-10T21:01:40.000Z","dependencies_parsed_at":"2024-01-05T05:48:04.337Z","dependency_job_id":null,"html_url":"https://github.com/ni5arga/RedditWikiBot","commit_stats":null,"previous_names":["ni5arga/redditwikibot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni5arga%2FRedditWikiBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni5arga%2FRedditWikiBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni5arga%2FRedditWikiBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ni5arga%2FRedditWikiBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ni5arga","download_url":"https://codeload.github.com/ni5arga/RedditWikiBot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223511421,"owners_count":17157518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mirror","moderation","praw","reddit","reddit-api","reddit-wiki","subreddit","subreddit-wiki","subreddits","wiki"],"created_at":"2024-11-07T12:22:23.348Z","updated_at":"2024-11-07T12:22:24.374Z","avatar_url":"https://github.com/ni5arga.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RedditWikiBot\nRedditWikiBot is a bot that facilitates the synchronization of Reddit wiki pages with a GitHub repository and vice versa.\nIt 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.\n\n## Table of Contents\n- [Introduction](#introduction)\n- [Features](#features)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Introduction\n\nRedditWikiBot consists of two main scripts:\n- **RedditToGithub.py**: Mirrors subreddit wiki pages to a specified GitHub repository.\n- **GithubToReddit.py**: Mirrors GitHub repository wiki pages to a specified subreddit.\n\n## Features\n\n- Bidirectional synchronization of wiki pages between Reddit and GitHub.\n- Customizable configuration to skip certain pages or directories.\n- Error handling for various scenarios, such as missing files or network issues.\n\n## Requirements\n\n- Python 3.x\n- PRAW (Python Reddit API Wrapper)\n- PyGithub\n\n## Installation\n\n1. Clone the GitHub repository:\n\n   ```bash\n   git clone https://github.com/ni5arga/RedditWikiBot.git\n   ```\n2. Install the required Python packages:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n## Configuration\n\nCreate a `.env` file in project root directory with the following credentials.\n\n```env\n# Reddit API credentials\nREDDIT_CLIENT_ID=your_reddit_client_id\nREDDIT_CLIENT_SECRET=your_reddit_client_secret\nREDDIT_USER_AGENT=your_reddit_user_agent\nREDDIT_USERNAME=your_reddit_username\nREDDIT_PASSWORD=your_reddit_password\n\n# GitHub credentials\nGITHUB_TOKEN=your_github_token\nGITHUB_REPO_OWNER=REPO_OWNER_USERNAME\nGITHUB_REPO_NAME=YOUR_REPO_NAME\n\n# Other configurations\nSUBREDDIT_NAME=your_subreddit_name\nMIRROR_CONFIG=TRUE/FALSE (Setting true will mirror config/ files too, recommended to keep false)\n```\nReplace `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.\n \n## Usage \n### RedditToGitHub.py\nRun the following command to mirror subreddit wiki pages to the GitHub repository:\n\n```bash\npython RedditToGithub.py\n```\n### GithubToReddit.py\nRun the following command to mirror GitHub repository wiki pages to the subreddit:\n\n```bash\npython GithubToReddit.py\n```\n\n## Contributing\nFeel free to contribute to the project by opening issues or submitting pull requests. Your feedback and contributions are highly appreciated!\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fni5arga%2Fredditwikibot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fni5arga%2Fredditwikibot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fni5arga%2Fredditwikibot/lists"}