Changes between Initial Version and Version 1 of TracSlimTimerPluginDevelopersGuide


Ignore:
Timestamp:
Apr 27, 2007, 9:14:08 AM (8 years ago)
Author:
tst
Comment:

Initial version

Legend:

Unmodified
Added
Removed
Modified
  • TracSlimTimerPluginDevelopersGuide

    v1 v1  
     1This describes the code for the TracSlimTimerPlugin.
     2
     3The pertinent files for the the synchronisation part of the module are as follows:
     4
     5 * [source:tracslimtimerplugin/0.10/tracslimtimer/__init__.py __init__.py] — Needs to import any trac Components so they are correctly loaded.
     6 * [source:tracslimtimerplugin/0.10/tracslimtimer/api.py api.py] — The steps for upgrading (setting-up) the environment for the plugin.
     7 * [source:tracslimtimerplugin/0.10/tracslimtimer/admin_ui.py admin_ui.py] — The administration panels.
     8 * [source:tracslimtimerplugin/0.10/tracslimtimer/slimtimer.py slimtimer.py] — A Python API to !SlimTimer.
     9 * [source:tracslimtimerplugin/0.10/tracslimtimer/ticket_change.py ticket_change.py] — The listener for ticket change events.
     10 * [source:tracslimtimerplugin/0.10/tracslimtimer/users.py users.py] — A user registry class.
     11
     12There is also a separate [source:tracslimtimerplugin/0.10/tests folder for unit tests] that should be run against any changes to the code.
     13
     14For the reporting module the most important file is the strangely named `dump_users.py`. This is the entry point to the reporting. It should be executable from the command line (may need a chmod +x dump_users.py).
     15
     16Notice that the first line of the file is:
     17
     18{{{
     19#!/opt/trac/0.10.3/install/bin/python
     20}}}
     21
     22This should cause the script to run with trac's Python rather than any other version of Python installed on the system.