| 1 | SvnBot |
|---|
| 2 | |
|---|
| 3 | A commit notification bot |
|---|
| 4 | |
|---|
| 5 | SvnBot is intended to be a small, simple, IRC bot that sends out a |
|---|
| 6 | message when a commit is made to a repository. |
|---|
| 7 | |
|---|
| 8 | Other projects exist that cover similar functionality: |
|---|
| 9 | |
|---|
| 10 | * The CIA Open Source Notification System[1] tracks project |
|---|
| 11 | activities and presents some statistics about projects. It has |
|---|
| 12 | the ability to provide notification via an IRC bot. |
|---|
| 13 | |
|---|
| 14 | * whippingboy[2] is an IRC bot (thought to be a Supybot[3] with an |
|---|
| 15 | RSS plugin) that polls the timeline for projects using Trac, |
|---|
| 16 | notifying on any new changes, including commits to the |
|---|
| 17 | repository. |
|---|
| 18 | |
|---|
| 19 | The main reasons for creating yet another bot were for its |
|---|
| 20 | simplicity, and as a personal programming exercise. |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | Requirements |
|---|
| 24 | |
|---|
| 25 | SvnBot is written in Python, and uses the Twisted API: |
|---|
| 26 | |
|---|
| 27 | * Python (>=2.2), from http://python.org/ |
|---|
| 28 | * Twisted 1.3, from http://twistedmatrix.com/ |
|---|
| 29 | (untested in Twisted 2) |
|---|
| 30 | |
|---|
| 31 | |
|---|
| 32 | Downloading |
|---|
| 33 | |
|---|
| 34 | There is no convenient package to download yet. Instead, make sure |
|---|
| 35 | you have Subversion[4] installed and grab the latest development |
|---|
| 36 | version from the repository: |
|---|
| 37 | |
|---|
| 38 | svn checkout \ |
|---|
| 39 | http://svn.sward.vm.bytemark.co.uk/repos/misc/svnbot/trunk svnbot |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | Configuration and Usage |
|---|
| 43 | |
|---|
| 44 | There are no configuration files yet. Just edit svnbot.py to change |
|---|
| 45 | the IRC server and channel, and run with: |
|---|
| 46 | |
|---|
| 47 | twistd -oy svnbot.py |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | License |
|---|
| 51 | |
|---|
| 52 | Svnbot is free software; you can redistribute it and/or modify it |
|---|
| 53 | under the terms of version 2 of the GNU General Public License[5] as |
|---|
| 54 | published by the Free Software Foundation.[6] |
|---|
| 55 | |
|---|
| 56 | Svnbot is distributed in the hope that it will be useful, but WITHOUT |
|---|
| 57 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|---|
| 58 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public |
|---|
| 59 | License[5] for more details. |
|---|
| 60 | |
|---|
| 61 | You should have received a copy of the GNU General Public License[5] |
|---|
| 62 | along with Svnbot; if not, write to the Free Software Foundation, |
|---|
| 63 | Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | References |
|---|
| 67 | |
|---|
| 68 | 1. http://cia.navi.cx/ |
|---|
| 69 | 2. http://whippingboy.homeunix.org/ |
|---|
| 70 | 3. http://supybot.com/ |
|---|
| 71 | 4. http://subversion.tigris.org/ |
|---|
| 72 | 5. http://www.fsf.org/licensing/licenses/gpl.html |
|---|
| 73 | 6. http://www.fsf.org/ |
|---|
