安装指南
========

操作系统要求
-------------
KunLun AutoTest暂支持以下操作系统:

1. Win10
2. Ubuntu 18.04+

安装包下载
-------------

请从以下地址下载最新pip安装包, 安装包名以 ``tar.gz`` 结尾:

https://gitee.com/robinwu0607/kunlun-atp/releases

Python版本要求
----------------
KunLun AutoTest要求Python版本为 ``3.8.10``.

安装方法
-------------

Win10安装 Python
^^^^^^^^^^^^^^^^^^
Win10 Python3.8.10下载地址: https://www.python.org/downloads/release/python-3810/

.. image:: ../_static/安装指南/python1.PNG

按照下图勾选对应的选项, 将安装路径加入到环境变量中。
注意安装路径为:  ``C:\Python3.8\`` .

.. image:: ../_static/安装指南/python2.PNG


安装 Visual Studio
^^^^^^^^^^^^^^^^^^^^^^

可以从以下地址下载最新版本 Visual Studio Installer.

``https://learn.microsoft.com/zh-cn/visualstudio/install/install-visual-studio?view=vs-2022``

选择工作负载 -> Python开发 -> Python本机开发工具, 然后点击安装即可.

.. image:: ../_static/安装指南/visualstudio.PNG

安装 KunLun AutoTest
^^^^^^^^^^^^^^^^^^^^^^^^^

请将 ``pip`` 工具先行升级到最新版本, 再安装KunLun AutoTest, 否则可能遇到依赖包 ``cryptography`` 安装失败的问题.

``pip install --upgrade pip``

使用 ``pip install kunlun-xx.xx.xx.tar.gz`` 即可, ``pip`` 工具会自动安装相关依赖.

需要说明的是: 如果用户是升级KunLun AutoTest, 升级前需要使用 ``kunlun stop`` 将相关服务先停止, 避免升级
时遇到文件被占用，导致升级不成功的问题. 然后再执行 ``pip install`` 指令.

安装完成后, 命令行工具 ``kunlun`` 即为可用状态， 可以使用 ``import kunlun`` 确认安装成功::

  (.venv) C:\kunlun-data>python
  Python 3.8.10 (tags/v3.8.10:3d8993a, May  3 2021, 11:48:03) [MSC v.1928 64 bit (AMD64)] on win32
  Type "help", "copyright", "credits" or "license" for more information.
  >>> import kunlun
  >>> 

也可以使用命令行 ``kunlun -h`` 打印帮助信息:: 

  Usage: kunlun [start|stop|web|info]

  - start   Start KunLun AutoTest Service.
  - stop    Stop KunLun AutoTest Service.
  - web     Open KunLun AutoTest WebPage.
  - info    Show KunLun Autotest Service Status.
  - run     Run KunLun Test Case per CLI.
  - menu    Run KunLun Test Case per MENU.
  - package   Package local project as zip, eg: kunlun package demo
  - update    Update remote project.zip to local, eg: kunlun update demo 192.168.1.100
  - deploy    Deploy local project.zip to remote, eg: kunlun deploy demo 192.168.1.100
  - upgrade   Upgrade local KunLun version, eg: kunlun upgrade 192.168.1.100