Changeset 9

Show
Ignore:
Timestamp:
16/09/05 22:59:51 (7 years ago)
Author:
simon
Message:

Replaced README with one derived from the project description on the project wiki.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • svnbot/trunk/README

    r8 r9  
    1 svnbot -- A commit notification bot: 
     1SvnBot 
    22 
    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 
    84 
    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. 
    1221 
    1322 
    14 REQUIREMENTS 
     23Requirements 
    1524 
    16 svnbot is written in Python, and uses the Twisted API: 
     25   SvnBot is written in Python, and uses the Twisted API: 
    1726 
    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) 
    2030 
    2131 
    22 USAGE 
     32Downloading 
    2333 
    24 Twisted provides packaging facilities to supposedly make things easy on 
    25 running and configuring Twisted applications, but I haven't done that 
    26 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: 
    2737 
    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 
    3240 
    3341 
    34 TODO 
     42Configuration and Usage 
    3543 
    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 
    3748 
    3849 
    39 LICENSE 
     50License 
    4051 
    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] 
    4455 
    45 Svnbot is distributed in the hope that it will be useful, but WITHOUT 
    46 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
    47 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. 
    4960 
    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  USA 
     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 
    5364 
    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 
     66References 
     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/