https://github.com/annsanns/modfax

Send a pm to all mods of a subreddit (Replacement for https://www.reddit.com/r/mod_mailer/wiki/index which stopped working)
https://github.com/annsanns/modfax

Last synced: 9 days ago
JSON representation

Send a pm to all mods of a subreddit (Replacement for https://www.reddit.com/r/mod_mailer/wiki/index which stopped working)

• Host: GitHub
• URL: https://github.com/annsanns/modfax
• Owner: AnnsAnns
• License: eupl-1.2
• Created: 2024-02-04T11:13:28.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-09T16:40:11.000Z (9 months ago)
• Last Synced: 2024-02-09T17:50:51.609Z (9 months ago)
• Language: Python
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ModFax

ModFax is a Python project that utilizes Poetry and Praw to provide a streamlined way of broadcasting messages to all moderators/approved submitters of a subreddit.

## Installation

1. `poetry install`

## Configuration

1. `cp config.example.py config.py`

2. Fill in the necessary fields in `config.py`

## Usage

1. `poetry run python main.py`

## How To Use

1. Make sure you and the bot are both moderators of the subreddit you want to broadcast to.

2. Write a private message to the bot with the subreddit as the subject (e.g. `testsubreddit`) and the message being the message you want to broadcast, including Markdown.

3. The bot will then broadcast the message to all moderators of the subreddit.

## License

This work is under the [European Union Public License v1.2](LICENSE) or – as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence");

You may get a copy of this license in your language from the European Commission [here](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12).

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the Licence for the specific language governing permissions and limitations under the Licence.