github.com/Scurrra/hamilton

Telegram Bot API wrapper for Crystal

6 stars
0 dependents
License: MIT

Nothing has been indexed for 0.1.1 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

# Add this to your shard.yml
dependencies:
  hamilton:
    github: Scurrra/hamilton
    version: ~> 0.1.1

Then run:

shards install

shard.yml

No shard.yml has been indexed for 0.1.1. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

hamilton

Crystal wrapper for Telegram Bot API (updated to 9.6) with optional async execution. Telegram Mini Apps are not supported.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      hamilton:
        github: Scurrra/hamilton
  2. Run shards install

Usage

require "hamilton"

API = Hamilton::Api.new(token: "<YOUR-API-TOKEN>")

handler = Hamilton::CmdHandler.new

@[Handler(handler)]
@[Handle(command: "/start")]
def handle_start_command(argument, context, update)
  # logic here
  return nil
end

@[Handler(handler)]
@[Handle(command: "help")]
def handle_help_command(argument, context, update)
  # logic here
  return nil
end

bot = Hamilton::Bot.new(
  api: API,
  handlers: [
    Hamilton::LogHandler.new, 
    handler
  ]
)

Signal::INT.trap do
  bot.stop
end

bot.listen

Usage guide with detailed explanation and example of the async bot can be found here.

Contributing

  1. Fork it (https://github.com/Scurrra/hamilton/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors