Documentation: EH Forwarder Bot

blueset(50)

Published in

#utopian-io

Words

236

Reading

2 min

Listen

Play

banner

Details

Author of the full documentation of EH Forwarder Bot.
EH Forwarder Bot (EFB) is an extensible chat tunnel framework which allows users to contact people from other chat platforms, and ultimately remotely control their accounts in other platforms.

Components

The full documentation of the project, which includes:

Getting started
Launch the framework
Directories
Profiles
Development guide
- Walk-through — How EFB works
  - Concepts to know
  - Slave Channels
  - Master Channels
  - Middlewares
- Slave channels
  - Methods to be implemented
  - Extra functions
  - Message commands
  - Message delivery
- Master channels
  - Design guideline
  - Message delivery
- Middlewares
  - Message and Status Processing
  - Other Usages
- Media processing
  - Choosing media formats
  - Media encoders
  - Files in messages
- Configurations and storage
  - Configurations and Permanent Storage
  - Temporary Storage
- Packaging and Publish
  - Publish your module on PyPI
  - Module discovery
  - Example
  - Private modules
- Miscellaneous
  - Logging
  - Vendor-specifics
  - Threading
How to contribute
API Documentations
- EFBChannel
  - Common operations
    - Sending messages and statuses
- EFBChat
- Constants
- Coordinator
- Exceptions
- EFBMsg
  - Examples
    - Primer: Defining related chats
    - Initialization and marking chats
    - Marking message references (targeted message)
    - Edit a previously sent message
    - Type-specific Information
    - Additional information
- EFBMiddleware
- Status
- Utilities