Skip to main content

Weixin for Flask.

Project description

Flask-Weixin is the implementation for http://mp.weixin.qq.com/ with the flavor of Flask. It can be used without Flask too.

Wheel Status Latest Version Travis CI Coverage Status

Installation

You can install Flask-Weixin with pip:

$ pip install Flask-Weixin

Or, with setuptools easy_install in case you didn’t have pip:

$ easy_install Flask-Weixin

Getting Started

Eager to get started? It is always the Flask way to create a new instance:

from flask_weixin import Weixin

weixin = Weixin(app)

Or pass the app later:

weixin = Weixin()
weixin.init_app(app)

However, you need to configure before using it, here is the configuration list:

  • WEIXIN_TOKEN: this is required

  • WEIXIN_SENDER: a default sender, optional

  • WEIXIN_EXPIRES_IN: not expires by default

For Flask user, it is suggested that you use the default view function:

app.add_url_rule('/', view_func=weixin.view_func)

@weixin.register('*')
def reply(**kwargs):
    username = kwargs.get('sender')
    sender = kwargs.get('receiver')
    content = kwargs.get('content')
    return weixin.reply(
        username, sender=sender, content=content
    )

The example above will reply anything the user sent.

Message Types

Every message from weixin has these information:

  • id: message ID

  • receiver: which is ToUserName in the official documentation

  • sender: which is FromUserName in the official documentation

  • type: message type

  • timestamp: message timestamp

Text Type

Text type has an extra data: content.

Image Type

Image type has an extra data: picurl.

Location Type

Location type has extra data:

  • location_x

  • location_y

  • scale

  • label

Event Type

Event type has extra data:

  • event

  • event_key

  • latitude

  • longitude

  • precision

Voice Type

Event type has extra data:

  • media_id

  • format

  • recognition

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Weixin-0.5.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

Flask_Weixin-0.5.0-py2.py3-none-any.whl (8.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-Weixin-0.5.0.tar.gz.

File metadata

File hashes

Hashes for Flask-Weixin-0.5.0.tar.gz
Algorithm Hash digest
SHA256 02a1322db3917e79aaae9bc9d08228ee68abfa9c813cc3193b7a5a675fe45436
MD5 9f24cd64cef63508648986bcc3ea048e
BLAKE2b-256 ca4f284c1bfa88442e65f350137d42cd12dc411321387bde1fd812a84df1a335

See more details on using hashes here.

Provenance

File details

Details for the file Flask_Weixin-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Weixin-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 29487d678e1f45b039779e7ba61a95645e4c83bd7b0118ff828b4a12f9afb5c0
MD5 2b7b2807184a2d8de0f0739e576d0a07
BLAKE2b-256 4d06777e890737fae0046a1e384cc9b9a9a5d5b936dfb2270e45aa3904678b70

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page