Metadata-Version: 2.1
Name: lyrebird
Version: 1.11.3
Summary: UNKNOWN
Home-page: https://github.com/meituan/lyrebird
Author: HBQA
License: UNKNOWN
Description: 
        <p align="center"><a herf="https://meituan-dianping.github.io/lyrebird/"><img src="./image/lyrebird.png" width="220"></a></p>
        <h1 align="center">Lyrebird</h1>
        
        [![Build Status](https://travis-ci.org/Meituan-Dianping/lyrebird.svg?branch=master)](https://travis-ci.org/Meituan-Dianping/lyrebird)
        [![PyPI](https://img.shields.io/pypi/v/lyrebird.svg)](https://pypi.python.org/pypi/lyrebird)
        ![PyPI](https://img.shields.io/pypi/pyversions/lyrebird.svg)
        ![GitHub](https://img.shields.io/github/license/meituan/lyrebird.svg)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/lyrebird.svg)
        [![Backers on Open Collective](https://opencollective.com/lyrebird/backers/badge.svg)](#backers) 
        [![Sponsors on Open Collective](https://opencollective.com/lyrebird/sponsors/badge.svg)](#sponsors) 
        [![Doc](https://img.shields.io/badge/docs-github_page-green.svg)](https://meituan-dianping.github.io/lyrebird/)
        
        ----
        
        # 目录
        
        - [简介](#简介)
        - [快速开始](#快速开始)
          - [环境要求](#环境要求)
          - [安装](#安装)
          - [启动](#启动)
          - [连接移动设备](#连接移动设备)
          - [查看及录制数据](#查看及录制数据)
          - [使用Mock数据](#使用Mock数据)
          - [Mock数据管理](#Mock数据管理)
        - [基本命令](#基本命令)
        - [感谢](#感谢)
        
        # 简介
        
        **Lyrebird** 是一个基于拦截以及模拟HTTP/HTTPS网络请求的面向移动应用的插件式测试平台。
        
        **Lyrebird** 不只提供UI操作，也可以通过API控制所有功能。
        
        **Lyrebird** 也可作为服务端接口测试mock工具使用。
        
        **Lyrebird** 可以通过**插件**扩展能力，实现埋点自动测试、API覆盖率统计、移动设备及APP控制和信息记录、自定义检查脚本等一系列功能。
        
        
        > Lyrebird (琴鸟) 不但美丽壮观，且能歌善舞。它不但能模仿各种鸟类的鸣叫声，还能学人间的各种声音。如汽车喇叭声、火车喷气声、斧头伐木声、修路碎石机声及领号人的喊叫声等。歌声婉转动听，舞姿轻盈合拍，是澳洲鸟类中最受人喜爱的珍禽之一。
        
        
        ----
        
        
        # 快速开始
        
        
        ## 环境要求
        
        * macOS
        
        * Python >= 3.6
        
        ```bash
        # 推荐使用Homebrew(https://brew.sh/#install)安装Python3
        brew install python3
        ```
        
        ## 安装
        
        ```bash
        # 安装lyrebird
        pip3 install lyrebird
        ```
        
        ## 启动
        
        ```bash
        lyrebird
        ```
        
        ## 连接移动设备
        
        * 启动Lyrebird后，移动设备需要通过代理的方式将请求数据接入。
        
        * 将移动设备的代理地址设为当前电脑地址，默认端口为4272（IP地址可查看Lyrebird启动时输出的日志）
        
        * 被测设备上用浏览器打开 http://mitm.it, 选择对应操作系统安装证书
        
        >Lyrebird接入有两种方式:
        
        a. 设置代理
        
        <img src="./image/connect-by-proxy.png" width="800">
        
        b. 直连
        
        <img src="./image/direct-connect.png" width="800">
        
        
        ## 查看及录制数据
        
        > 现在，可以开始操作移动设备了。Lyrebird将显示捕获到的HTTP/HTTPS请求。
        >
        > 选中请求后，可以将它保存到已激活的mock数据组中。
        
        <img src="./image/1_7_0_inspector.gif" width="800">
        
        
        ## 使用Mock数据
        
        > 激活mock数据选择器，选择mock数据后。经过Lyrebird的请求会被mock，如果mock数据中没有匹配的数据，则会代理该请求。
        > 
        > 可以在DataManager界面管理mock数据。
        
        <img src="./image/1_7_0_inspector_mock.gif" width="800">
        
        
        ## Mock数据管理
        
        > mock数据可由左边导航栏切换到DataManager界面进行编辑管理
        
        <img src="./image/1_7_0_data_manager.gif" width="800">
        
        
        ----
        
        ## 插件
        
        ----
        
        # 基本命令
        
        * **lyrebird**
        
            以缺省参数启动lyrebird
        
        * **lyrebird -v**
        
            以输出详细日志模式启动lyrebird
        
        * **lyrebird -b**
        
            启动lyrebird不默认打开浏览器
        
        * **lyrebird --mock 9090 --proxy 4272 --data . --config your/config/file**
        
            指定参数启动lyrebird
        
            参数：
        
                --mock 默认9090 ， mock服务及前端端口
        
                --proxy 默认4272， 代理服务端口
        
                --data 默认./data, mock数据根目录
                
                --config 默认~/.lyrebird/conf.json, lyrebird启动配置
        
        ----
        
        # 感谢
        
        本工具中的代理功能使用[mitmproxy](https://github.com/mitmproxy/mitmproxy)实现。
        
        ## Contributors
        
        This project exists thanks to all the people who contribute. 
        <a href="https://github.com/Meituan-Dianping/lyrebird/graphs/contributors"><img src="https://opencollective.com/lyrebird/contributors.svg?width=890&button=false" /></a>
        
        
        ## Backers
        
        Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/lyrebird#backer)]
        
        <a href="https://opencollective.com/lyrebird#backers" target="_blank"><img src="https://opencollective.com/lyrebird/backers.svg?width=890"></a>
        
        
        ## Sponsors
        
        Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/lyrebird#sponsor)]
        
        <a href="https://opencollective.com/lyrebird/sponsor/0/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/0/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/1/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/1/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/2/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/2/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/3/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/3/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/4/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/4/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/5/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/5/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/6/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/6/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/7/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/7/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/8/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/8/avatar.svg"></a>
        <a href="https://opencollective.com/lyrebird/sponsor/9/website" target="_blank"><img src="https://opencollective.com/lyrebird/sponsor/9/avatar.svg"></a>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Description-Content-Type: text/markdown
Provides-Extra: dev
