https://github.com/ehforwarderbot/efb-mp-instantview-middleware
https://github.com/ehforwarderbot/efb-mp-instantview-middleware
efb-middleware eh-forwarder-bot
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ehforwarderbot/efb-mp-instantview-middleware
- Owner: ehForwarderBot
- Created: 2020-12-31T07:42:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-25T13:06:29.000Z (about 1 year ago)
- Last Synced: 2025-04-25T14:23:49.499Z (about 1 year ago)
- Topics: efb-middleware, eh-forwarder-bot
- Language: Python
- Size: 37.1 KB
- Stars: 3
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MPInstantViewMiddleware: A middleware for EFB
## Notice
**Middleware ID**: `catbaron.mp_instantview`
The middleware ID was `catbaron.mp_instanceview` 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 an `access_token` (introduced below).
## 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://:@:
# proxy_url: socks5://:
# proxy_url: http://:
proxy_url: PROXY_URL
```
### Restart EFB.