Metadata-Version: 2.1
Name: Flask-DXCaptcha
Version: 1.0.7
Summary: Flask-DXCaptcha是依赖顶象科技提供的无感验证功能开发的Flask 扩展
Home-page: https://github.com/durban89/flask_dxcaptcha
Author: durban zhang
Author-email: durban.zhang@gmail.com
License: MIT
Description: Flask-DXCaptcha
        ===============
        
        Flask-DXCaptcha是依赖顶象科技提供的无感验证功能开发的Flask 扩展
        
        安装Flask-DXCaptcha
        ------------------------
        
        使用 **pip** 安装
        
        .. code-block:: text
          
          pip install Flask-DXCaptcha
          
        
        配置
        ------
        
        ``the-config.cfg`` 文件添加配置项
        
        .. code-block:: text
        
          DX_APP_ID = 'xxx' # APP_ID
          DX_APP_SECRECT = 'xxx' # APP_SECRECT
        
        
        
        APP_ID和APP_SECRECT需要从 `顶象科技官网`_ 获取
        
        跟其他扩展使用的方式类似，简单介绍如下
        
        .. code-block:: python
        
          from flask_dxcaptcha import DXCaptcha
        
          app = Flask(__name__)
          app.config.from_pyfile('the-config.cfg')
          dxcaptcha = DXCaptcha(app)
        
        
        或者 
        
        .. code-block:: python
        
          from flask import Flask
          from flask_dxcaptcha import DXCaptcha
          dxcaptcha = DXCaptcha()
          ...
          app = Flask(__name__)
          app.config.from_pyfile('the-config.cfg')
          dxcaptcha.init_app(app)
        
        
        如何使用
        --------------
        
        .. code-block:: python
        
          dxcaptcha.client.setTimeOut(2)
        
          response = dxcaptcha.client.checkToken(v_token)
        
          if response['serverStatus'] == 'SERVER_SUCCESS':
              if response['result'] is False:
                  pass
                  # token验证失败，业务系统可以直接阻断该次请求或者继续弹验证码
                  # 具体的实现逻辑
          else:
              pass
              # '提交验证失败，请重新提交'
              # 具体的实现逻辑
        
        
        ``v_token`` 值的获取可以参考 `官网`_ 文档，下面仅是示例
        
        html
        
        .. code-block:: html
        
          <form>
            <div id='c1'></div>
            <input id='v_token' name='v_token' />
          </form>
        
        javascript
        
        .. code-block:: javascript
        
          <script src="https://cdn.dingxiang-inc.com/ctu-group/captcha-ui/index.js"></script>
        
          <script type='text/javascript'>
          var myCaptcha = _dx.Captcha(document.getElementById('c1'), {
            appId: 'appId', // appId
            style: 'popup',
            width: '100%',
            success: function (token) {
              document.getElementById('v_token').value = token;
              myCaptcha.hide();
            }
          });
          myCaptcha.show();
          </script>  
        
        
        .. _顶象科技官网: https://www.dingxiang-inc.com/
        .. _官网: https://www.dingxiang-inc.com/
Platform: any
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7.4
Description-Content-Type: text/x-rst
