pipobot
  • 1. Presentation
  • 2. Requirements
  • 3. Configuration
    • 3.1. Config section
    • 3.2. Database section
      • 3.2.1. SQLite configuration
      • 3.2.2. MySQL or PostgreSQL configuration
    • 3.3. Room section
    • 3.4. Group section
    • 3.5. Module-config section
    • 3.6. Testing section
  • 4. Invocation
    • 4.1. General command-line options
    • 4.2. Check-modules mode
    • 4.3. Unit-test mode
    • 4.4. Script mode
    • 4.5. Interactive mode
  • 1. Architecture of a module
    • 1.1. Types of modules
      • 1.1.1. SyncModule
      • 1.1.2. MultiSyncModule
      • 1.1.3. AsyncModule
      • 1.1.4. ListenModule
      • 1.1.5. PresenceModule
    • 1.2. What they can return
      • 1.2.1. A string
      • 1.2.2. A list of strings
      • 1.2.3. A dictionary
      • 1.2.4. Nothing, None or “”
    • 1.3. Using configuration parameters
  • 2. Specific description of modules
    • 2.1. SyncModule
      • 2.1.1. Definition of module
      • 2.1.2. Writing handlers
    • 2.2. MultiSyncModule
    • 2.3. AsyncModule
    • 2.4. ListenModule
    • 2.5. PresenceModule
  • 3. Some internal modules
    • 3.1. Help Module
      • 3.1.1. Description format
    • 3.2. User Monitoring Module
  • 4. High-Level Modules
    • 4.1. FortuneModule
    • 4.2. NotifyModule
  • 1. Unit Tests
    • 1.1. Write a ModuleTest class
    • 1.2. Run your tests
  • 1. Internationalisation
  • 2. Translation handling
    • 2.1. New language
    • 2.2. Update an existing language
  • 1. Pipobot Package
    • 1.1. config Module
    • 1.2. bot Module
    • 1.3. bot_jabber Module
    • 1.4. bot_test Module
    • 1.5. bot_twisted Module
    • 1.6. Subpackages
      • 1.6.1. lib Package
        • 1.6.1.1. bdd Module
        • 1.6.1.2. exceptions Module
        • 1.6.1.3. modules Module
        • 1.6.1.4. abstract_modules Module
        • 1.6.1.5. parsedates Module
        • 1.6.1.6. user Module
        • 1.6.1.7. known_users Module
        • 1.6.1.8. loader Module
        • 1.6.1.9. utils Module
        • 1.6.1.10. module_test Module
 
pipobot
  • Docs »

© Copyright 2012, pipo™.

Built with Sphinx using a theme provided by Read the Docs.