README.md

TOC Project 2017

Template Code for TOC Project 2017

A telegram bot based on a finite state machine

Setup

Prerequisite

• Python 3

Install Dependency

pip install -r requirements.txt

• pygraphviz (For visualizing Finite State Machine)
  • Setup pygraphviz on Ubuntu

Secret Data

API_TOKEN and WEBHOOK_URL in app.py MUST be set to proper values. Otherwise, you might not be able to run your code.

Run Locally

You can either setup https server or using ngrok as a proxy.

ngrok would be used in the following instruction

ngrok http 5000

After that, ngrok would generate a https URL.

You should set WEBHOOK_URL (in app.py) to your-https-URL/hook.

Run the sever

python3 app.py

Finite State Machine

Usage

The initial state is set to user.

Every time user state is triggered to advance to another state, it will go_back to user state after the bot replies corresponding message.

• user

  • Input: "go to state1"

    • Reply: "I'm entering state1"

  • Input: "go to state2"

    • Reply: "I'm entering state2"

Author

Lee-W