Bot.md

Bot Name

---

🤖 Few lines describing what your bot does.

📝 Table of Contents

• About
• Demo / Working
• How it works
• Usage
• Getting Started
• Deploying your own bot
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Write about 1-2 paragraphs describing the purpose of your bot.

🎥 Demo / Working

💭 How it works

The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API.

If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API.

The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server.

The entire bot is written in Python 3.6

🎈 Usage

To use the bot, type:

!dict word

The first part, i.e. "!dict" is not case sensitive.

The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply.

Example:

!dict what is love

Definition:

Baby, dont hurt me~ Dont hurt me~ no more.

Example:

Dude1: Bruh, what is love? Dude2: Baby, dont hurt me, dont hurt me- no more! Dude1: dafuq?

Source: https://www.urbandictionary.com/define.php?term=what%20is%20love

---

^{Beep boop. I am a bot. If there are any issues, contact my Master}

^{Want to make a similar reddit bot? Check out: GitHub}

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Give examples

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo.

🚀 Deploying your own bot

To see an example project on how to deploy your bot, please see my own configuration:

• Heroku: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot

⛏️ Built Using

• PRAW - Python Reddit API Wrapper
• Heroku - SaaS hosting platform

✍️ Authors

• @kylelobo - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References