Changeset 9 for svnbot/trunk
- Timestamp:
- Sep 16, 2005, 10:59:51 PM (19 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
svnbot/trunk/README
r8 r9 1 svnbot -- A commit notification bot: 1 SvnBot 2 2 3 As nice as the CIA Open Source Notification System[1] is, I wanted 4 something a little more simple. I was not overly interested in 5 statistics, and Trac[2] provides most of what I need in a web-based 6 interface to Subversion[3], I just wanted a simple IRC bot that would 7 alert people when something is committed to a repository. 3 A commit notification bot 8 4 9 Since I have been present in the #trac IRC channel on Freenode, I have 10 noticed whippingboy[4]. I am told this is just a Supybot[5] with an RSS 11 plugin, which polls Trac's timeline RSS feed from a cron job. 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. 12 21 13 22 14 R EQUIREMENTS23 Requirements 15 24 16 svnbot is written in Python, and uses the Twisted API:25 SvnBot is written in Python, and uses the Twisted API: 17 26 18 * Python (>=2.2), from http://python.org/ 19 * Twisted 1.3, from http://twistedmatrix.com/ (untested in Twisted 2) 27 * Python (>=2.2), from http://python.org/ 28 * Twisted 1.3, from http://twistedmatrix.com/ 29 (untested in Twisted 2) 20 30 21 31 22 USAGE 32 Downloading 23 33 24 Twisted provides packaging facilities to supposedly make things easy on 25 running and configuring Twisted applications, but I haven't done that26 yet. :) 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: 27 37 28 Instead, edit svnbot.py to change the IRC server and channel, and run 29 with: 30 31 twistd -oy svnbot.py 38 svn checkout \ 39 http://svn.sward.vm.bytemark.co.uk/repos/misc/svnbot/trunk svnbot 32 40 33 41 34 TODO 42 Configuration and Usage 35 43 36 * Stuff 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 37 48 38 49 39 L ICENSE50 License 40 51 41 Svnbot is free software; you can redistribute it and/or modify it under 42 the terms of version 2 of the GNU General Public License as published by 43 the Free Software Foundation. 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] 44 55 45 Svnbot is distributed in the hope that it will be useful, but WITHOUT46 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or47 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 48 for more details.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. 49 60 50 You should have received a copy of the GNU General Public License along 51 with Svnbot; if not, write to the Free Software Foundation, Inc., 51 52 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA61 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 53 64 54 ---- 55 1. http://cia.navi.cx/ 56 2. http://www.edgewall.com/trac/ 57 3. http://subversion.tigris.org/ 58 4. http://whippingboy.homeunix.org/ 59 5. http://supybot.com/ 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/
Note: See TracChangeset
for help on using the changeset viewer.