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
Contributors
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

Project Title

Few lines describing your project.

🧐 Problem Statement

It is useful to design and follow a specific format when writing a problem statement. While there are several options for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain focus on defining the problem.

IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section should illustrate what the expected environment would look like once the solution is implemented.
REALITY: This section is used to describe the current or “as is” state of the process or product.
CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon. This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.

Following this format will result in a workable document that can be used to understand the problem and elicit requirements that will lead to a winning solution.

💡 Idea / Solution

This section is used to describe potential solutions.

Once the ideal, reality, and consequences sections have been completed, and understood, it becomes easier to provide a solution for solving the problem.

⛓️ Dependencies / Limitations

What are the dependencies of your project?
Describe each limitation in detailed but concise terms
Explain why each limitation exists
Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if appropriate, describe how these limitations could point to the need for further research.