Metadata-Version: 1.2
Name: efb-fb-messenger-slave
Version: 2.0.0b13
Summary: Facebook Messenger Slave Channel for EH Forwarder Bot, based on ``fbchat``.
Home-page: https://github.com/blueset/efb-fb-messenger-slave
Author: Eana Hufwe
Author-email: ilove@1a23.com
License: AGPLv3+
Description: EFB Facebook Messenger Slave (EFMS)
        ===================================
        
        .. image:: https://img.shields.io/pypi/v/efb-fb-messenger-slave.svg
           :alt: PyPI release
           :target: https://pypi.org/project/efb-fb-messenger-slave/
        .. image:: https://d322cqt584bo4o.cloudfront.net/ehforwarderbot/localized.svg
           :alt: Translate this project
           :target: https://crowdin.com/project/ehforwarderbot/
        
        `README in other languages`_.
        
        .. _README in other languages: ./readme_translations
        .. TRANSLATORS: change the URL on previous line as "." (without quotations).
        
        **Channel ID**: ``blueset.fbmessenger``
        
        EFMS is a channel that connects to Facebook Messenger for EH Forwarder
        Bot, based on simulation of Facebook Messenger Web, and
        `fbchat <https://github.com/carpedm20/fbchat>`_.
        
        Beta version
        -------------
        
        This is an unstable beta version, and its functionality may change at any
        time.
        
        Requirements
        ------------
        
        -  Python >= 3.6
        -  EH Forwarder Bot >= 2.0.0
        
        Getting started
        ---------------
        
        1. Install required binary dependencies
        2. Install
        
           .. code:: shell
        
               pip3 install efb-fb-messenger-slave
        
        3. Enable the channel in the profile’s ``config.yaml``.
        
           The path to the current profile may vary depends on your
           configuration.
        
           **(In EFB 2.0.0a1, the default profile path is**
           ``~/.ehforwarderbot/profiles/default`` **)**
        
        4. Sign in
        
           .. code:: shell
        
               $ efms-auth
        
           And follow the instructions.
        
        Known issues
        ------------
        - Messages from threads in ``MARKETPLACE`` type (i.e. messages from interested
          buyers on Facebook Marketplace) cannot be processed.
        - Live location cannot be updated properly.
        - Poll messages, reminders and events are not yet supported.
        - Voice calls are not planned to be supported.
        
        Optional configuration file
        ---------------------------
        
        EFMS allows user to enable or disable experimental features with the
        configuration file. It is located at
        ``<Path to current profile>/blueset.fbmessenger/config.yaml``.
        
        Example
        ~~~~~~~
        
        .. code:: yaml
        
            # Experimental flags
            # This section can be used to enable experimental functionality.
            # However, those features may be changed or removed at any time.
            # Options in this section is explained afterward.
            flags:
                option_one: 10
                option_two: false
                option_three: "foobar"
        
        Tips and tricks
        ---------------
        
        -  To send large emoji, send the emoji as text following by ``S``,
           ``M``, or ``L`` as small, medium and large emoji accordingly.
           For example, to send a large smile emoji, send ``😆L``.
        
        Experimental flags
        ------------------
        
        The following flags are experimental features, may change, break, or
        disappear at any time. Use at your own risk.
        
        -  ``proxy_links_by_facebook`` *(bool)* [Default: ``false``]
        
           Deliver links (including links in share entities and thumbnails)
           using Facebook’s proxy. Disable this option to show the source
           directly.
        
        -  ``send_link_with_description`` *(bool)* [Default: ``false``]
        
           When processing link message from the Master Channel, attach the
           title and description besides the link when the option is enabled.
        
           .. note::
                Regardless of this option, link messages are sent as text, and
                Facebook Messenger may or may not attach its own link preview per its
                system configuration.*
        
        -  ``show_pending_threads`` *(bool)* [Default: ``false``]
        
           When showing the threads list, include threads pending approval.
        
        -  ``show_archived_threads`` *(bool)* [Default: ``false``]
        
           When showing the threads list, include archived threads.
        
        Vendor-specifics
        ----------------
        
        EFMS’s chats provides the following vendor specific options:
        
        * ``'chat_type'`` *(str)*: Type of the thread: ``'User'``, ``'Page'``, or
          ``'Group'``.
        * ``'profile_picture_url'`` *(str)*: URL to the thread’s
          profile picture.
        
        Translations support
        --------------------
        
        EFMS supports translated user interface prompts experimentally,
        by setting the locale environmental variable (``LANGUAGE``,
        ``LC_ALL``, ``LC_MESSAGES`` or ``LANG``) to one of our
        `supported languages`_. Meanwhile, you can help to translate
        this project into your languages on `our Crowdin page`_.
        
        .. _supported languages: https://crowdin.com/project/ehforwarderbot/
        .. _our Crowdin page: https://crowdin.com/project/ehforwarderbot/
Keywords: ehforwarderbot,EH Forwarder Bot,EH Forwarder Bot Master Channel,facebook messenger,messenger,chatbot
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.6
