Metadata-Version: 2.1
Name: solox
Version: 2.1.4
Summary: SoloX - Real-time collection tool for Android/iOS performance data.
Home-page: https://github.com/smart-test-ti/SoloX
Author: Rafa Chen
Author-email: rafacheninc@gmail.com
License: MIT
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flask (>=2.0.1)
Requires-Dist: requests
Requires-Dist: logzero
Requires-Dist: Flask-SocketIO (==4.3.1)
Requires-Dist: fire
Requires-Dist: python-engineio (==3.13.2)
Requires-Dist: python-socketio (==4.6.0)
Requires-Dist: Werkzeug (==2.0.3)
Requires-Dist: Jinja2 (==3.0.1)
Requires-Dist: tidevice (>=0.9.7)

<p align="center">
  <a>README</a> | <a href="./DocForAndroid.md">DocForAndroid</a>
</p>

<p align="center">
<a href="#">
<img src="https://cdn.nlark.com/yuque/0/2022/png/153412/1643364757640-b4529458-ec8d-42cc-a2d8-c0ce60fdf50f.png" alt="SoloX" width="300">
</a>
<br>
<br>

</p>
<p align="center">
<a href="https://pypi.org/project/solox/" target="__blank"><img src="https://img.shields.io/pypi/v/solox" alt="solox preview"></a>
<a href="https://smart-test-ti.github.io/apm.html" target="__blank"><img src="https://img.shields.io/badge/preview-demo-orange"></a>

<br>
</p>

## Preview

SoloX - Real-time collection tool for Android/iOS performance data.

We are committed to solving inefficient, cumbersome test execution, and our goal is Simple Test In SoloX!

<img src="./image/home.png"  width="100%">

## Installation
```
1.Python:3.6+ 
2.pip3 install -U solox

notice: If Windows users need to test ios, install and start Itunes
```

## Startup SoloX
### default
```shell
python3 -m solox
```
### customize

```shell
python3 -m solox --host=0.0.0.0 --port=50003
```

## Collect in python 
```python
from solox.public.apm import APM
# solox version >= 2.1.2

apm = APM(pkgName='com.bilibili.app.in',deviceId='ca6bd5a5',platform='Android')
# apm = APM(pkgName='com.bilibili.app.in', platform='iOS') only supports one device
cpu = apm.collectCpu() # %
memory = apm.collectMemory() # MB
flow = apm.collectFlow() # KB
fps = apm.collectFps() # HZ
battery = apm.collectBattery() # level:% temperature:°C
```

## Collect in API 
### Start the service in the background

```
# solox version >= 2.1.4

macOS/Linux: nohup python3 -m solox &
Windows: start /min python3 -m solox &
```

### Request apm data from api
```
url: http//localhost:50003/apm/collect
methods: ['post', 'get']
request parameters: platform=Android&deviceid=ca6bd5a5&pkgname=com.bilibili.app.in&apm_type=cpu
apm_type in ['cpu','memory','network','fps','battery']
```

## Thanks
- https://github.com/alibaba/mobileperf

- https://github.com/alibaba/taobao-iphone-device

## Communicate
- QQ: 1501556640
- Gmail: rafacheninc@gmail.com

