Botup

Botup is command-line tool that generates basic skeleton for telegram bot.

Installation

Just run this in your terminal:

$ gem install botup

Usage

Bootstrap new telegram bot was never so simple!

$ botup my_super_bot # Provide bot name in snake_case
$ cd my_super_bot && bundle install # Install dependencies

What's in the bot?

.
|____bin
| |____my_super_bot             # Executable for starting your bot client
|____config
| |____config.yml               # Config file storing bot token
|____Gemfile 
|____lib
| |____my_super_bot
| | |____client.rb              # Core telegram bot class; takes token and answer to any command sent
| | |____commands_keeper.rb     # Stores all available commands (includes test command by deault); 
| | |____commands_manager.rb    # Takes command and handles next step
| | |____message_parser.rb      # Parses sent message to command and params
| | |____messenger.rb           # Handles current chat item and sends output to user
| |____my_super_bot.rb

How to use your bot

  • Add your bot's token to config/config.yml

  • Add desired methods to lib/YOUR_BOT_NAME/commands_keeper.rb. For example, to implement command /today_schedule just create appropriate method:

    def today_schedule
    Schedule.new(Time.now).call 
end

  • Start bot:

    $ my_super_bot/bin/my_super_bot

  • Try it out by sending /test command(or some other command that you have already implemented)

  • Sit back and take a glass of Pina Colada!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/vaihtovirta/botup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Credits

Originally was inspired(and partially borrowed) by telegram_meetup_bot.

License

The gem is available as open source under the terms of the MIT License.