Metadata-Version: 2.1
Name: efb-mp-instantview-middleware
Version: 0.3.1
Summary: WeChat Middleware of EH Forwarder Bot to enable instant        view for official accounts' articles
Home-page: https://github.com/catbaron0/efb-mp-instant-middleware
Author: catbaron
Author-email: catbaron@live.cn
License: AGPLv3+
Description: # MPInstantViewMiddleware: A middleware for EFB
        
        ## Notice
        
        **Middleware ID**: `catbaron.mp_instantview`
        
        The middleware ID was `catbaron.mp_instantview` before version 0.3.0. Please take care of it, especially please remeber to update the configure file of EFB (`$HOME/.ehforwarderbot/profiles/default/config.yaml`).
        
        **MPInstantViewMiddleware** is a middleware of EFB enable instant view for articles of official accounts.
        
        ## How it works
        This middleware generates a telegraph page for links sent by official accounts of wechat, which will enable the instant view. Thus you need a `access_token` (introduced later).
        
        ## Dependense
        * Python >= 3.6
        * EFB >= 2.0.0
        * PyYaml
        * bs4
        * requests[sock]
        
        ## Install and configuration
        
        ### Install
        ```
        pip install efb-mp-instantview-middleware
        ```
        
        ### Enable
        
        Register to EFB
        Following [this document](https://ehforwarderbot.readthedocs.io/en/latest/getting-started.html) to edit the config file. The config file by default is `$HOME/.ehforwarderbot/profiles/default`. It should look like:
        
        ```yaml
        master_channel: foo.demo_master
        slave_channels:
        - foo.demo_slave
        - bar.dummy
        middlewares:
        - foo.other_middlewares
        - catbaron.mp_instantview
        ```
        
        You only need to add the last line to your config file.
        
        ### Configure the middleware
        
        The config file by default is `$HOME/.ehforwarderbot/profiles/default/catbaron.mp_instantview/config.yaml`.
        Please create the config file if there is not one. You need to have a telegraph token and save it here. You can get a token following [the document](https://telegra.ph/api#createAccount). The `access_token` is what you need.
        
        This middleware need access to https://telegra.ph, add the proxy url to the configure file if necessary.
        
        ```yaml
        # Token of telegraph
        telegraph_token: ACCESS_TOKEN
        
        # Optional. Proxy url.
        # Example:
        #  proxy_url: socks5://<user>:<pass>@<host>:<port>
        #  proxy_url: socks5://<host>:<port>
        #  proxy_url: http://<host>:<port>
        proxy_url: PROXY_URL
        ```
        
        ### Restart EFB.
        
        
Keywords: ehforwarderbot,EH Forwarder Bot,EH Forwarder Bot Slave Channel,wechat,weixin,chatbot
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
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
Description-Content-Type: text/markdown
