Yet Another Urban Dictionary Bot

@yet_another_urban_dictionary_bot | GitHub

• How to use me
• Commands
• My other bots
• Contributions
  • Bug report / Feature request
  • Code Contribution / Pull Requests
  • Local installation

How to use me

Just send me any text and I try to find the definition in Urban Dictionary for you. Like this you don't have to extra open the another app and this whole slow process.

Commands

• /help, /start: show this help message.
• /define: The same as when you send me text directly, search on Urban Dictionary for it's definition.

My other bots

Please share this bot with your friends so that I (the magician behind this project) have enough motivation to continue and maintain this bot.

Check out my other project[s]:

• @insta_looter_bot - Download images and videos from Instagram via Telegram
• @reverse_image_search_bot - Reverse image search directly in Telegram

Contributions

Bug report / Feature request

If you have found a bug or want a new feature, please make an issue here: Nachtalb/yet_another_urban_dictionary_bot

Code Contribution / Pull Requests

Please use a line length of 120 characters and Google Style Python Docstrings.

Local installation

Instead of the old pip with requirements.txt I use the new and fancy pipenv with pipfile. If you read the intro to pipenv and pipfile you will understand why I use it.

With this info we now install our virtualenv with:

pip install pipenv  # Install pipenv
pipenv --three      # Create virtualeenv from your python3 installation
pipenv install      # Install all requirements
pipenv shell        # Spawn shell for your pipenv virtualenv

After this is complete, you have to get an API Token from Telegram. You can easily get one via the @BotFather.

Now that you have your API Token copy the settings.example.py to settings.py and paste in your API Token. Finally you can use this to start your bot.

python run_bot.py

Thank you for using @yet_another_urban_dictionary_bot.