https://github.com/dolph/irc-standup-bot
Automated cat herding for IRC-based standup meetings.
https://github.com/dolph/irc-standup-bot
Last synced: 12 months ago
JSON representation
Automated cat herding for IRC-based standup meetings.
- Host: GitHub
- URL: https://github.com/dolph/irc-standup-bot
- Owner: dolph
- License: apache-2.0
- Created: 2015-12-02T19:28:58.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-04T17:35:23.000Z (over 10 years ago)
- Last Synced: 2025-04-04T15:52:54.208Z (about 1 year ago)
- Language: Python
- Size: 28.3 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
===============
IRC Standup Bot
===============
A simple script to provide automated cat herding for IRC-based standups.
Schedule the bot to run via a cron job, and it'll connect to your IRC server,
join the meeting channel, ping all the meeting attendees (even if they're not
in the meeting channel), and thank the participants when the meeting is over.
------------
Installation
------------
Clone this repo, and install the project's dependencies (perhaps in a
virtualenv)::
$ pip install -r requirements.txt
And then just run the script directly.
-----
Usage
-----
::
$ python bot.py --help
usage: bot.py [-h] [--port PORT] [--password PASSWORD] [--ssl]
[--standup-duration STANDUP_DURATION] [--topic TOPIC]
server channel nickname nickname-to-ping [nickname-to-ping ...]
positional arguments:
server The IRC server to connect to.
channel The IRC channel to hold the standup in.
nickname The IRC nickname to use.
nickname-to-ping List of users to ping at the beginning of the standup.
optional arguments:
-h, --help show this help message and exit
--port PORT The IRC server's port.
--password PASSWORD The IRC server's password.
--ssl The IRC server requires SSL.
--standup-duration STANDUP_DURATION
Standup duration in seconds (the default is 15
minutes).
--topic TOPIC What to invite everyone to
So, you can use cron to schedule a standup every weekday at 17:00 UTC (server
time) with `dolphm`, `dstanek`, and `lbragstad` on Freenode in the
`#standup-channel` (the `#` prefix is optional; use quotes if you want to
specify a `"##private-channel"` like so::
0 17 * * 1-5 python ~/irc-standup-bot/bot.py chat.freenode.net standup-channel dolph_bot dolphm dstanek lbragstad