https://github.com/ac-alpha/bunku-the-bot
https://github.com/ac-alpha/bunku-the-bot
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ac-alpha/bunku-the-bot
- Owner: ac-alpha
- Created: 2018-09-28T21:54:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-30T00:10:41.000Z (over 7 years ago)
- Last Synced: 2025-09-25T12:52:04.316Z (9 months ago)
- Language: Python
- Size: 137 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bunku the bot
This bot allows users to keep track of their attendance and remain updated with schedule of their classes.
To use
Bunku the bot, you can simply call it with `@Bunku` followed by a command,
like so:
```
@Bunku
```
## Setup
- Clone the python-zulip-api repository `git clone https://github.com/zulip/python-zulip-api.git`
- Navigate into your cloned repository `cd python-zulip-api`
- Install `pip install virtualenv`
- Install all requirements in a Python virtualenv `python3 ./tools/provision`
- Activate python3 virtual environment
- Install `pip install zulip_bots`
- Install `pip install graphqlclients`
- Clone Bunku-the-Bot repository `https://github.com/ac-alpha/Bunku-the-Bot.git`
- Navigate into bot repository
- Run the bot using command `zulip-terminal bunku`
- Add the bot to zulip workspace and download the zuliprc file for your bot.
- Move the `zuliprc` file to the `bunku` repository
- Start the bot using command `zulip-run-bot bunku --config zuliprc`
- You are good to interact with the bot
## Usage
This bot has following six commands.
1. `startrecording` : to start recording your leaves
2. `left class`: to record a leave for particular course code
3. ` class cancelled` : to report about a course class cancelled
4. `extra class
### Usage examples
| Message | Response |
| ------- | ------ |
| `@Bunku startrecording` | aagarwal@cs.iitr.ac.in Started recording your attendance |
| `@Bunku attendancerecord` |aagarwal@cs.iitr.ac.in
---Stats---
csn221 : 42/42 100.0%
hss01 : 31/31 100.0%
ecn203 : 41/41 100.0%
csn291 : 51/51 100.0%
min106 : 61/61 100.0%
csn261 : 30/30 100.0%
----------- |