ScribrBot acts as a Scribe for Telegram groups. Once it is added to a group, it can keep track of discussion topics by hashtag and present the threads of discussion when requested.
ScribrBot runs on AWS, using Lambda, API Gateway, DynamoDB and S3. All of these resources are setup using a standard CloudFormation template that requires IAM access.
A TestScribrBot instance is runing on a Telegram group. If you wish to test it and provide feedback please join the group by visiting this link from a mobile device where Telegram is installed.
- CloudFormation template to setup all required resources
- Deployment script that sets up all the resources and registers ScribrBot with Telegram
- Basic handler that stores the message data in a table
- Discard all messages other than those with hashtags
- Provide summarise command
\summto summarise messages by hashtag
- Respond with error message if no messages in #hashtag to be summarised (Issue #10)
- Greet new group joiners (Issue #6)
- Separate summary page Jinja template from the bot package (Issue #1)
- Provide basic CSS Grid layout for summary page (Issue #2)
- Ignore messages more than 'n' chars long (Issue #18)
- Create your own Telegram bot from within the Telegram app as described here
- Install Python 2.7 (or above), virtualenv, pip and git
- Setup an AWS S3 bucket in the same region where you intend to deploy the bot
- Setup AWS config including credentials of an IAM user that has access to the necessary AWS services as described here
- Clone this repository:
$ git clone https://github.com/shreepads/scribrbot.git - In the repo directory create a Python 2.7 virtual environment:
$ virtualenv --verbose --python=python2.7 venv - Activate the virtual environment:
$ source venv/bin/activate - Install the necessary Python packages:
(venv) $ pip install -r requirements.txt - Deploy the bot, providing the Telegram bot token obtained at the first step
and the name of the S3 bucket created at the third step:
(venv) $ ./deploy_scribrbot.py --telegram_token <insert token here> --s3bucket <s3 bucket name>
- At the time ScribrBot is deployed, a Telegram user must be identified as the Bot Owner.
- The Bot Owner can add ScribrBot to Telegram Groups and in each Group specify which Telegram users in the Group will act as Group Owners
- Group Owners can control certain features on the Group, other Group users can post messages to the group as usual with Hashtags
- ScribrBot will track each message posted with Hashtags (multiple tags can be associated with a message)
- ScribrBot will present the conversation around each Hashtag