~ubuntu-branches/ubuntu/utopic/gozerbot/utopic

« back to all changes in this revision

Viewing changes to doc/TOURDECODE

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2009-09-14 09:00:29 UTC
  • mfrom: (1.1.4 upstream) (3.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090914090029-uval0ekt72kmklxw
Tags: 0.9.1.3-3
Changed dependency on python-setuptools to python-pkg-resources
(Closes: #546435) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
============
2
 
TOUR DE CODE
3
 
============
4
 
 
5
 
__copyright__ = 'this file is in the public domain'
6
 
 
7
 
bot dir
8
 
~~~~~~~
9
 
::
10
 
  
11
 
  (bart@dunker):~/gozerbot/tour/gozerbot
12
 
  $ ls
13
 
  README  contrib  files     gozerplugs  setup.py  tests
14
 
  bin     doc      gozerbot  runbot      stop
15
 
  
16
 
  doc .. documents
17
 
  files .. scripts and other files
18
 
  gozerbot .. module providing gozerbot core code
19
 
  gozerplugs .. package that holds the bot's plugins
20
 
  runbot .. main program
21
 
  stop .. script to stop the bot
22
 
  tests .. directory with unittests
23
 
  bin .. directory with binaries
24
 
  contrib .. files contributed but not in the public domain
25
 
  
26
 
gozerplugs
27
 
~~~~~~~~~~
28
 
::
29
 
  
30
 
  $ ls
31
 
  __init__.py  dbplugs  plugs  web
32
 
 
33
 
  
34
 
doc
35
 
~~~
36
 
::
37
 
  
38
 
  (bart@dunker):~/gozerbot/tour/gozerbot/doc
39
 
  $ ls
40
 
  BASIC       FLEET   OPER           RELAY  TOURDECODE  USER
41
 
  COLLECTIVE  FLOW    PLUGINS        RSS    UDP         WEBSERVER
42
 
  FAQ         JABBER  PROGRAMPLUGIN  THNX   UPGRADE
43
 
  
44
 
  BASIC .. basic bot commands
45
 
  OPER .. bot OPER manual
46
 
  PROGRAMPLUGIN .. doc about making your own plugin
47
 
  RSS .. describes the rss functionality
48
 
  THNX .. people
49
 
  UPDATING .. read when you try to upgrade from an old gozerbot
50
 
  UPGRADE .. show how the bot can be upgraded to a newer version
51
 
  USER .. doc about managing users
52
 
  FLEET .. about running multiple bots
53
 
  FLOW .. describes the basic data flow of the bot
54
 
  PLUGINS .. description of the plugins
55
 
  
56
 
files
57
 
~~~~~
58
 
::
59
 
  
60
 
  (bart@dunker):~/gozerbot/tour/gozerbot/files
61
 
  $ ls
62
 
  dcctest.py  gozerbot.cron  onconnect         qtest.py   svnlog.py
63
 
  dotest.py   hammer.py      pickletomysql.py  setup.py   toudp.py
64
 
  gb_db       mailudp.py     plugdeny          sqlite_db
65
 
  
66
 
  coredbtogozer.py .. when upgrading from corebotdb
67
 
  coretogozer.py .. upgrades from corebot
68
 
  dcctest.py .. script thats tests the bot by making DDC chats to the bot and
69
 
                run the examples as commands
70
 
  dotest.py .. script to run unittests
71
 
  gb_db .. mysql database template
72
 
  hammer.py .. run one command multiple times
73
 
  mailudp.py .. example of file to include in .forward so mail -> irc gateway
74
 
                is possible
75
 
  nagios-udp .. nagios mail -> irc gateway
76
 
  onconnect .. example of file to run when bot connects to an irc server
77
 
  qtest.py .. use Queues to test bot
78
 
  svnlog.py .. file to use for svn commit -> irc gateway
79
 
  toudp.py .. stdout -> irc gateway
80
 
  
81
 
gozerbot
82
 
~~~~~~~~
83
 
bots core code
84
 
::
85
 
  
86
 
  $ ls 
87
 
  __init__.py   dol.py           jabberpresence.py  persist.py
88
 
  aliases.py    eventhandler.py  less.py            persistconfig.py
89
 
  backup.py     examples.py      limiter.py         plughelp.py
90
 
  bot.py        exit.py          limlist.py         plugins.py
91
 
  callbacks.py  fleet.py         lockmanager.py     redispatcher.py
92
 
  channels.py   generic.py       monitor.py         rsslist.py
93
 
  commands.py   ignore.py        myimport.py        statdict.py
94
 
  config.py     irc.py           nextid.py          thr.py
95
 
  datadir.py    ircevent.py      partyline.py       users.py
96
 
  db.py         jabberbot.py     pdod.py            wait.py
97
 
  dbusers.py    jabbermsg.py     pdol.py
98
 
  
99
 
  backup.py .. makes backup of the data dir
100
 
  bot.py .. defines the Bot class
101
 
  callbacks.py .. enables callbacks
102
 
  channels.py .. Channel class used to store channel related data 
103
 
  commands.py .. bot commands infrastructure
104
 
  config.py .. holds the config dictionary
105
 
  db.py .. does the mysql interfacing
106
 
  dbusers.py .. mysql related users code
107
 
  dol.py .. a dol is a dict of lists
108
 
  examples .. examples and descriptions of the commands
109
 
  fleet.py .. fleet is a list of bots, used to connect to multiple servers
110
 
  generic.py .. generic functions and stuff
111
 
  irc.py .. defines the core bot code handling irc stuff
112
 
  limlist.py .. limited list aka list with max number of elements
113
 
  monitor.py .. use to register callbacks that gets called when certain
114
 
                monitor events happen
115
 
  more.py .. enable bots response caching
116
 
  myimport.py .. provide absolute path importing
117
 
  nextid.py .. dict with counters to provide ids
118
 
  partyline.py .. talk with other people via dcc chat
119
 
  pdod.py .. pickled dict of dicts
120
 
  pdol.py .. pickled dict of lists
121
 
  persist.py .. used to pickle data
122
 
  plugins.py .. provides plugin related functionality
123
 
  redispatcher.py .. regular expression dispatcher
124
 
  statdict.py .. dict used for stats
125
 
  thr.py .. give thread the name of the command excecuting
126
 
  udp.py .. code for udp listen thread
127
 
  users.py .. users related code
128
 
  wait.py .. register callbacks on irc events
129
 
  datadir.py .. app wide datadir
130
 
  
131
 
plugs
132
 
~~~~~
133
 
::
134
 
    
135
 
  (bart@dunker):~/gozerbot/tour/gozerbot/gozerplugs/plugs
136
 
  $ ls 
137
 
  __init__.py    core.py        infoitem.py        misc.py         tail.py
138
 
  alarm.py       count.py       install.py         mono.py         to.py
139
 
  alert.py       country.py     irc.py             nickcapture.py  todo.py
140
 
  alias.py       dig.py         jabber.py          not.py          topic.py
141
 
  autovoice.py   dns.py         jcoll.py           ops.py          udp.py
142
 
  away.py        event.py       karma.py           probe.py        update.py
143
 
  birthday.py    fleet.py       limiter.py         quote.py        upgrade.py
144
 
  botsnack.py    googletalk.py  links.py           relay.py        user.py
145
 
  chanperm.py    greeting.py    lists.py           reload.py       webserver.py
146
 
  choice.py      grep.py        log.py             remind.py
147
 
  code.py        hello.py       mail.py            rss.py
148
 
  collective.py  idle.py        mailexceptions.py  shop.py
149
 
  convert.py     ignore.py      markov.py          size.py
150
 
 
151
 
see doc/PLUGINS for plugin description
152
 
 
153
 
database plugs
154
 
~~~~~~~~~~~~~~
155
 
::
156
 
  
157
 
  (bart@dunker):~/gozerbot/tour/gozerbot/gozerplugs/dbplugs
158
 
  $ ls
159
 
  __init__.py     infoitem.py     quote.py        user.py
160
 
  birthday.py     karma.py        todo.py
161
 
  
162
 
  birthday.py .. manages birthdays 
163
 
  karma.py .. manages karma
164
 
  quote.py .. does the quotes thing
165
 
  todo.py .. todo 
166
 
  user.py .. user related plugin
167
 
  
 
 
b'\\ No newline at end of file'