HACKATHON-BOT

Telegram bot for getting upcoming hackathons according to location

ABOUT

HACKATHON-BOT is a telegram bot built in python 3 using python-telegram-bot wrapper.

FEATURES

• Getting upcoming hackathons according to location
• Subscribing to get upcoming hackathons every month

LIBRARIES USED

• PYTHON-TELEGRAM-BOT
• HTML5LIB
• BEAUTIFUL SOUP
• APSCHEDULER
• GOOGLEMAPS

USAGE

PREREQUISITES

• python 3 or above

CONFIGURATION

• Create your bot and Get your telegram bot token from BotFather

• Get your google maps geocoding api key from Google Maps Geocoding api

• Get your telegram chat id

  • You can get your chat id by first messaging to the bot and then checking the url https://api.telegram.org/botYourBOTToken/getUpdates
    It will look somewhat like this
    {"update_id":8393,"message":{"message_id":3,"from":{"id":7474,"first_name":"AAA"},"chat":{"id":,"title":""},"date":25497,"new_chat_participant":{"id":71,"first_name":"NAME","username":"YOUR_BOT_NAME"}}}
    the id of the chat object is your chat id

• Edit the config.ini file with your telegram bot token, google geocoding api key. Also put your chat id in admin chat id. You can put multiple admin chat ids seperated by comma. Admins will have access to admin commands. You can also put your persistent storage point if you will be using OPENSHIFT ONLINE to host the bot (If name of your volume is df then put /df/ in the field) otherwise just leave the field blank

RUNNING ON LOCAL PC

• pip install requirements.txt in console
• run app.py script
• enjoy

HOSTING ON OPENSHIFT ONLINE

• edit the config.ini file
• save all the files in a repository on github
• create an account on REDHAT OPENSHIFT ONLINE
• select the location of your server
• wait for a few days till you recieve confirmation
• after recieving confirmation, login and create new application
• select python 3.4 or above
• select name and everything
• enter the url of the github repository
• wait for application to start
• enjoy
• You will have to use persistent storage to prevent data loss on deployments
  • think of a name for mount point eg /df
  • open the openshift console
  • go to storage and create a persistent storage
  • Go to deployments
  • then in deployment configuration attach the persistent storage along with a mount point you thought of
  • wait for the app to re-deploy
  • enjoy

REBUILDING PROJECT ON OPENSHIFT ONLINE

when you want to rebuild your project

• first of all go to deployments and select the latest deployment

• downscale the no of pods to 0 and wait for it to happen

• IMPORTANT go to deployment configuration and detach the storage. A deployment will start, let it finish

• Go to builds, select name and click on start build

• After finishing build a deployment will start, let it finish

• Go back to deployment configuration and add storage with same mount point as previous and wait for a new deployment

• After deployment finishes, go to deployments. Select latest and scale the pod to 1.

• YOU CAN REMOVE YOUR GITHUB REPOSITORY BUT MAKE SURE TO RECREATE IT WHEN REBUILDING YOUR PROJECT

COMMANDS

PUBLIC COMMANDS

• /help - get a list of all the commands
• /upcoming - get a list of upcoming hackathons
  
• /set_location - set your location
  
• /subscribe - subscribe to get a list of upcoming hackathons every week
  
• /unsubscribe - unsubscribe from the above

ADMIN COMMANDS

• /givememydb - get the sqlite database
• /senddb - send and replace sqlite database
• /broadcast - send message to all users of bot