hubot-ibmcloud-translate
A Hubot script for translating messages with IBM Watson Language Translation.
Getting Started
Usage
Steps for adding this to your existing hubot:
cd
into your hubot directory- Install the Watson Translation functionality with
npm install hubot-ibmcloud-translate --save
- Add
hubot-ibmcloud-translate
to yourexternal-scripts.json
- Add the necessary environment variables:
export HUBOT_WATSON_TRANSLATE_API=WATSON
export HUBOT_WATSON_TRANSLATE_USER=<USERNAME>
export HUBOT_WATSON_TRANSLATE_PASSWORD=<PASSWORD>
Note: HUBOT_WATSON_TRANSLATE_API
is optional.
- Start up your bot & off to the races!
Commands
hubot translate help
- Show available commands in the ibmcloud translate category.hubot translate phrase <language> <phrase>
- Translate a phrase to a language.hubot translate list languages
- Show available languages to use for translation.
Hubot Adapter Setup
Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:
Cognitive Setup
This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.
Development
Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:
Configuration Setup
- Create
config
folder in root of this project. - Create
env
in theconfig
folder, with the following contents:
export HUBOT_WATSON_TRANSLATE_API=WATSON
export HUBOT_WATSON_TRANSLATE_USER=<USERNAME>
export HUBOT_WATSON_TRANSLATE_PASSWORD=<PASSWORD>
Note: HUBOT_WATSON_TRANSLATE_API
is optional.
- In order to view content in chat clients you will need to add
hubot-ibmcloud-formatter
to yourexternal-scripts.json
file. Additionally, if you want to usehubot-help
to make sure your command documentation is correct. Createexternal-scripts.json
in the root of this project, with the following contents:
[
"hubot-help",
"hubot-ibmcloud-formatter"
]
- Lastly, run
npm install
to obtain all the dependent node modules.
Running Hubot with Adapters
Hubot supports a variety of adapters to connect to popular chat clients.
If you just want to use:
- Terminal: run
npm run start
- Slack: link to setup instructions
- Facebook Messenger: link to setup instructions
License
See LICENSE.txt for license information.
Contribute
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.