nicolabs/nicobot
1
0
Fork 0
mirror of https://github.com/nicolabs/nicobot.git synced 2025-09-05 17:15:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of github.com/nicolabs/nicobot
23 commits 11 branches 12 tags 433 KiB
Python 79.1%
Dockerfile 13.9%
Shell 4.8%
Makefile 1.7%
Java 0.5%
Go to file
nicobo 9eec6a5d70
~ renamed sample-conf into transbot-sample-conf
2020-05-16 16:17:18 +02:00
nicobot
test/transbot-sample-conf
.gitignore
LICENSE
README.md
requirements.txt

README.md

nicobot

🤟 A collection of cool chat bots 🤟

Well, there's only one of them as of today... Plus it's absolutely EXPERIMENTAL : use it at your own risk !

It features :

Requirements & installation

Requires :

Install Python dependencies with :

pip3 install -r requirements.txt

See below for Signal requirements.

Transbot

Transbot is a demo chatbot interface to IBM Watson™ Language Translator service.

Again, this is NOT STABLE code, there is absolutely no warranty it will work or not harm butterflies on the other side of the world... Use it at your own risk !

The included sample configuration in test/transbot-sample-conf, demoes how to make it translate any message like nicobot <message> in chinese or simply nicobot <message> (into the current language).

It can also automatically translate messages containing keywords into a random language. The sample configuration shows how to make it translate any message containing "Hello" or "Goodbye" in many languages.

Quick start

  1. Install prerequistes ; for Debian systems this will look like : 
    sudo apt install python3 python3-pip
git clone https://github.com/nicolabs/nicobot.git
cd nicobot
pip3 install -r requirements.txt
  2. Create a Language Translator service instance on IBM Cloud and get the URL and API key from your console
  3. Fill them into test/transbot-sample-conf/config.yml (ibmcloud_url and ibmcloud_apikey)
  4. Run python3 nicobot/transbot.py -C test/transbot-sample-conf
  5. Input Hello world in the console : the bot will print a random translation of "Hello World"
  6. Input Bye nicobot : the bot will terminate

If you want to send & receive messages through Signal instead of reading from the keyboard & printing to the console :

  1. Install and configure signal-cli (see below for details)
  2. Run python3 nicobot/transbot.py -C test/transbot-sample-conf -b signal -u '+33123456789' -r '+34987654321' with -u +33123456789 your Signal number and -r +33987654321 the one of the person you want to make the bot chat with

See below for more options...

Main configuration options and files

Run transbot.py -h to get a description of all options.

Below are the most important configuration options :

  • --config-file and --config-dir let you change the default configuration directory and file. All configuration files will be looked up from this directory ; --config-file allows overriding the location of config.yml.
  • --keyword and --keywords-file will help you generate the list of keywords that will trigger the bot. To do this, run transbot.py --keyword <a_keyword> --keyword <another_keyword> ... a first time with : this will download all known translations for these keywords and save them into a keywords.json file. Next time you run the bot, don't use the --keyword option : it will reuse this saved keywords list. You can use --keywords-file to change the default name.
  • --languages-file : The first time the bot runs, it will download the list of supported languages into languages.<locale>.json and reuse it afterwards but you can give it a specific file with the set of languages you want. You can use --locale to set the desired locale.
  • --locale will select the locale to use for default translations (with no target language specified) and as the default parsing language for keywords.
  • --ibmcloud-url and --ibmcloud-apikey can be obtained from your IBM Cloud account (create a Language Translator instance then go to the resource list)
  • --backend selects the chatter system to use : it currently supports "console" and "signal" (see below)
  • --username selects the account to use to send and read message ; its format depends on the backend
  • --recipient and --group select the recipient (only one of them should be given) ; its format depends on the backend
  • --stealth will make the bot connect and listen to messages but print any answer instead of sending it ; useful to observe the bot's behavior in a real chatroom...

The i18n.<locale>.yml file contains localization strings for your locale and fun :

  • Transbot will say "Hello" when started and "Goodbye" before shutting down : you can configure those banners in this file.
  • It also defines the pattern that terminates the bot.

Finally, see the next chapter to learn about the config.yml file.

Config.yml configuration file

Options can also be taken from a configuration file : by default it reads the config.yml file in the current directory but can be changed with the --config-file and --config-dir options. This file is in YAML format with all options at the root level. Keys have the same name as command line options, with middle dashes - replaced with underscores _ and a s appended for lists (options --ibmcloud-url https://api... will become ibmcloud_url: https://api... and --keywords-file 1.json --keywords-file 2.json will become :

keywords_files:
    - 1.json
    - 2.json

A sample configuration is available in the test/transbot-sample-conf/ directory.

Please first review YAML syntax if you don't know about YAML.

Using the Signal backend

By using --backend signal you can make the bot chat with Signal users.

Prerequistes

You must first install and configure signal-cli.

Then you must register or link the computer when the bot will run ; e.g. :

signal-cli link --name MyComputer

Please see the man page for more details.

Signal-specific options

With signal, make sure :

  • the --username parameter is your phone number in international format (e.g. +33123456789). In config.yml, make sure to put quotes around it to prevent YAML thinking it's an integer (because of the 'plus' sign)
  • specify either --recipient as an international phone number or --group with a base 64 group ID (e.g. --group "mABCDNVoEFGz0YeZM1234Q=="). Once registered with Signal, you can list the IDs of the groups you are in with signal-cli -u +336123456789 listGroups

Sample command line to run the bot with Signal :

python3 nicobot/transbot.py -b signal -u +33612345678 -g "mABCDNVoEFGz0YeZM1234Q==" --ibmcloud-url https://api.eu-de.language-translator.watson.cloud.ibm.com/instances/a234567f-4321-abcd-efgh-1234abcd7890 --ibmcloud-apikey "f5sAznhrKQyvBFFaZbtF60m5tzLbqWhyALQawBg5TjRI"

Resources

Python libraries

None of them seems to support OMEMO out of the box :-(

IBM Cloud

Signal