Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meysam81/reddit-scheduled-submit
https://github.com/meysam81/reddit-scheduled-submit
api-wrapper automation bot ci-cd content-publishing devops github-actions github-workflow oauth2 praw python python-reddit-api reddit reddit-api reddit-automation reddit-bot reddit-integration scripting social-media social-media-automation
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/meysam81/reddit-scheduled-submit
- Owner: meysam81
- License: apache-2.0
- Created: 2024-08-13T03:16:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T19:31:47.000Z (about 2 months ago)
- Last Synced: 2024-09-17T00:45:12.508Z (about 2 months ago)
- Topics: api-wrapper, automation, bot, ci-cd, content-publishing, devops, github-actions, github-workflow, oauth2, praw, python, python-reddit-api, reddit, reddit-api, reddit-automation, reddit-bot, reddit-integration, scripting, social-media, social-media-automation
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Reddit Scheduled Submit
- [Reddit Scheduled Submit](#reddit-scheduled-submit)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Local Usage](#local-usage)
- [Docker](#docker)
- [GitHub Actions Usage](#github-actions-usage)
- [Contributing](#contributing)
- [License](#license)
- [Disclaimer](#disclaimer)
This repository contains a simple Python script that uses
the [PRAW] (Python Reddit API Wrapper) library to post a
message to Reddit.
It's designed to be easily integrated into GitHub Actions
workflows.
## Features
- Can be run as a GitHub Action
- Customizable title and message content
## Prerequisites
To use this script, you need:
1. A Reddit account
2. A Reddit application (create one at [here][reddit-apps])
3. Python 3.12 or higher
## Installation
Clone this repository:
```sh
git clone https://github.com/meysam81/reddit-scheduled-submit
```
Install the required dependencies:
```sh
pip install -r requirements.txt
```
## Usage
### Local Usage
```sh
export REDDIT_CLIENT_ID="CHANGE_THIS"
export REDDIT_CLIENT_SECRET="CHANGE_THIS"
export REDDIT_USERNAME="CHANGE_THIS"
export REDDIT_PASSWORD="CHANGE_THIS"
export REDDIT_SUBREDDIT="CHANGE_THIS"
./main.py --title "Hello, Reddit!" --message "This is a test message."
```
### Docker
To run the Docker container, you can use the following command:
```sh
docker run \
--rm \
--name reddit-scheduled-submit \
-e REDDIT_CLIENT_ID="CHANGE_THIS" \
-e REDDIT_CLIENT_SECRET="CHANGE_THIS" \
-e REDDIT_USERNAME="CHANGE_THIS" \
-e REDDIT_PASSWORD="CHANGE_THIS" \
-e REDDIT_SUBREDDIT="CHANGE_THIS" \
ghcr.io/meysam81/reddit-scheduled-submit:v1 \
--title "Hello, Reddit!" \
--message "This is a test message."
```
### GitHub Actions Usage
To use this script as a GitHub Action, you can create a workflow file (e.g.,
`.github/workflows/ci.yml`) with the following content:
```yaml
name: ci
on:
workflow_dispatch:
inputs:
title:
description: Post title
required: true
message:
description: Post message
required: true
subreddit:
default: r/test
description: Subreddit to post to
required: false
jobs:
reddit-scheduled-submit:
runs-on: ubuntu-latest
steps:
- name: Post to Reddit
uses: meysam81/reddit-scheduled-submit@v1
with:
client-id: ${{ secrets.REDDIT_CLIENT_ID }}
client-secret: ${{ secrets.REDDIT_CLIENT_SECRET }}
username: ${{ secrets.REDDIT_USERNAME }}
password: ${{ secrets.REDDIT_PASSWORD }}
subreddit: ${{ github.event.inputs.subreddit }}
message: ${{ github.event.inputs.message }}
title: ${{ github.event.inputs.title }}
```
Make sure to set up the following secrets in your GitHub
repository:
- `REDDIT_CLIENT_ID`
- `REDDIT_CLIENT_SECRET`
- `REDDIT_USERNAME`
- `REDDIT_PASSWORD`
## Contributing
Contributions are welcome! Please feel free to submit a
Pull Request.
## License
This project is licensed under the Apache-2.0 License -
see the [LICENSE](LICENSE) file for details.
## Disclaimer
This script is for educational purposes only. Make sure to
comply with Reddit's API terms of service and posting
guidelines when using this script.
[reddit-apps]: https://www.reddit.com/prefs/apps
[PRAW]: https://praw.readthedocs.io/en/latest/