Skip to content

KGBTR/flooodbot

Repository files navigation

FloooDBot

For your subreddit flood requirements.
View Demo  •  Report Bug  •  Request Feature

About The FloooDBot

This project for your subreddit's flood database as a bot

Requirements

  • python >= 3

Check via python --version

  • pip for dependencies installation

Check via pip --version

Getting Started

Deploy to Heroku

Deploy on Heroku

Local development

Clone or download this repository in your project directory and running follow these simple steps.

git clone https://github.com/KGBTR/FloooDBot.git

Installation

  1. Install dependencies
pip install -r requirements.txt
  1. Rename praw.example.ini to praw.ini

For MacOSX or linux mv praw.example.ini praw.ini

For Windows via Powershell Rename-Item praw.example.ini praw.ini or via CMD rename praw.example.ini praw.ini

  1. Run via python main.py

Usage

You can start using it with the command starting with !flood.

You can configure ! mark and flood command into floods.json config field.

Current avaliable example command:

  • !flood Genj adam
  • !flood Khontkar

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated 🤗.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

You can contact us on reddit.

u/Asim-Tahir u/Snapo82