From b2e8b207dfbf8ea9682e1cf4753ec01cc588eeb1 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Mon, 14 Aug 2017 22:46:37 +0800 Subject: [PATCH] make jenkins-mail-py as extras_require --- README.md | 35 ++++++++++++++++++++++++++++++++++- ate/__init__.py | 2 +- setup.py | 8 ++++++-- 3 files changed, 41 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5c5485a2..3171dc96 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,44 @@ To ensure the installation or upgrade is successful, you can execute command `at ```text $ ate -V -0.3.1 +0.3.2 ``` Execute the command `ate -h` to view command help. +```text +ate -h +usage: ate [-h] [-V] [--log-level LOG_LEVEL] [--report-name REPORT_NAME] + [--failfast] + [testset_paths [testset_paths ...]] + +Api Test Engine. + +positional arguments: + testset_paths testset file path + +optional arguments: + -h, --help show this help message and exit + -V, --version show version + --log-level LOG_LEVEL + Specify logging level, default is INFO. + --report-name REPORT_NAME + Specify report name, default is generated time. + --failfast Stop the test run on the first error or failure. +``` + +### use jenkins-mail-py addon + +If you want to use `ApiTestEngine` with Jenkins, you may need to send mail notification, and[`jenkins-mail-py`][jenkins-mail-py] will be of great help. + +To install mail helper, run this command in your terminal: + +```text +$ pip install -U git+https://github.com/debugtalk/jenkins-mail-py.git#egg=jenkins-mail-py +``` + +With [`jenkins-mail-py`][jenkins-mail-py] installed, you can see more optional arguments. + ```text $ ate -h usage: ate [-h] [-V] [--log-level LOG_LEVEL] [--report-name REPORT_NAME] diff --git a/ate/__init__.py b/ate/__init__.py index 9c5adf70..f37c5faf 100644 --- a/ate/__init__.py +++ b/ate/__init__.py @@ -1 +1 @@ -__version__ = '0.3.1' \ No newline at end of file +__version__ = '0.3.2' \ No newline at end of file diff --git a/setup.py b/setup.py index 70beb059..247bc4c3 100644 --- a/setup.py +++ b/setup.py @@ -27,9 +27,13 @@ setup( "PyYAML", "coveralls", "coverage", - "PyUnitReport", - "jenkins-mail-py" + "PyUnitReport" ], + extras_require={ + 'mail': [ + "jenkins-mail-py" + ] + }, dependency_links=[ "git+https://github.com/debugtalk/PyUnitReport.git#egg=PyUnitReport-0", "git+https://github.com/debugtalk/jenkins-mail-py.git#egg=jenkins-mail-py-0"