Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

HTK for Ruby

A set of convenience utils for Ruby. An inspired, close-to-feature-parity port of python-htk-lite.

Features

  1. Debug via Slack using ::Htk::Utils.slack_debug('some debugging message'). The best of println debugging, without the inconvenience of visually fishing for one message out of thousands of log lines.
  2. Debug via writing to local file using fdebug (::Htk::Utils.fdebug('some debugging message')) and fdebug_json (::Htk::Utils.fdebug_json(some_object)). Certifiably awesome, fast, and secure.

How to Use This Awesome?

  1. Clone this repository into a directory named htk (preferred) or htk_lite
    SSH: git clone git@github.com:hacktoolkit/htk-rb.git htk
    HTTPS: git clone https://github.com/hacktoolkit/htk-rb.git
  2. (Optional) Create a symlink to htk inside of your app's lib/ directory.
  3. Create local_settings.rb and add your Slack incoming webhook URL to SLACK_WEBHOOK_URL.
  4. In your code, simply do:
    ::Htk::Utils.slack_debug('This is seriously awesome!')
    ::Htk::Utils.slack_debug('Yeah, no kidding.')
    
  5. Check your Slack to verify that the message was posted. If not, perhaps your token was wrong, or the Slack integration was disabled. image
    (Alternative link to screenshot above: https://cl.ly/436cfb4383a2)
  6. Profit!

Tips on Location of HTK Module

  1. You can place it outside of your app directory tree, and then symlink it inside.
  2. To not be nagged by the presence of the htk directory whenever you do git status, add htk to your .git/info/exclude file (like .gitignore, but only in your local repository, not checked in).

See Also

Authors and Maintainers

License

MIT. See LICENSE.md