From d108209fe79ead795bfcbe5f6fb853292b61b0ed Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 18 Jul 2019 18:04:18 +0800 Subject: [PATCH] remove docs, move docs to universal repo https://github.com/HttpRunner/docs --- .travis.yml | 4 +- docs/CNAME | 1 - docs/FAQ.md | 20 -- docs/Installation.md | 96 ------ docs/Introduction.md | 28 -- docs/dev-rules.md | 47 --- docs/development.md | 23 -- docs/images/ate-quickstart-demo-report.jpg | Bin 40427 -> 0 bytes docs/images/ate-quickstart-http-1.jpg | Bin 114965 -> 0 bytes docs/images/ate-quickstart-http-2.jpg | Bin 108744 -> 0 bytes docs/images/github-flow.png | Bin 21040 -> 0 bytes docs/images/locusts-full-speed.jpg | Bin 65133 -> 0 bytes docs/images/qrcode_for_httprunner.jpg | Bin 27646 -> 0 bytes docs/index.md | 3 - docs/load-test.md | 45 --- docs/quickstart.md | 336 --------------------- docs/run-testcases.md | 34 --- docs/write-testcases.md | 142 --------- mkdocs.yml | 15 - 19 files changed, 2 insertions(+), 792 deletions(-) delete mode 100644 docs/CNAME delete mode 100644 docs/FAQ.md delete mode 100644 docs/Installation.md delete mode 100644 docs/Introduction.md delete mode 100644 docs/dev-rules.md delete mode 100644 docs/development.md delete mode 100644 docs/images/ate-quickstart-demo-report.jpg delete mode 100644 docs/images/ate-quickstart-http-1.jpg delete mode 100644 docs/images/ate-quickstart-http-2.jpg delete mode 100644 docs/images/github-flow.png delete mode 100644 docs/images/locusts-full-speed.jpg delete mode 100644 docs/images/qrcode_for_httprunner.jpg delete mode 100644 docs/index.md delete mode 100644 docs/load-test.md delete mode 100644 docs/quickstart.md delete mode 100644 docs/run-testcases.md delete mode 100644 docs/write-testcases.md delete mode 100644 mkdocs.yml diff --git a/.travis.yml b/.travis.yml index b0f4f2b8..1d917f66 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,8 +7,8 @@ python: matrix: include: - python: 3.7 - dist: xenial - sudo: true + dist: xenial # Required for Python 3.7 + sudo: true # Required for Python 3.7 install: - pip install poetry - poetry install -vvv diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index bdbfd759..00000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -httprunner.org \ No newline at end of file diff --git a/docs/FAQ.md b/docs/FAQ.md deleted file mode 100644 index 38583eb8..00000000 --- a/docs/FAQ.md +++ /dev/null @@ -1,20 +0,0 @@ -## Unable to install PyUnitReport dependency library automatically - -If there is something goes wrong in installation like below. - -```text -Downloading/unpacking PyUnitReport (from HttpRunner) - Could not find any downloads that satisfy the requirement PyUnitReport (from HttpRunner) -``` - -You could install `PyUnitReport` manully at first. - -```bash -$ pip install git+https://github.com/debugtalk/PyUnitReport.git#egg=PyUnitReport -``` - -And then everything will be OK when you reinstall `HttpRunner`. - -```bash -$ pip install git+https://github.com/debugtalk/HttpRunner.git#egg=HttpRunner -``` diff --git a/docs/Installation.md b/docs/Installation.md deleted file mode 100644 index d13a44af..00000000 --- a/docs/Installation.md +++ /dev/null @@ -1,96 +0,0 @@ -## Installation - -`HttpRunner` is available on [`PyPI`][PyPI] and can be installed through pip or easy_install. - -```bash -$ pip install HttpRunner -``` - -or - -```bash -$ easy_install HttpRunner -``` - -If you want to keep up with the latest version, you can install with github repository url. - -```bash -$ pip install git+https://github.com/HttpRunner/HttpRunner.git#egg=HttpRunner -``` - -## Upgrade - -If you have installed `HttpRunner` before and want to upgrade to the latest version, you can use the `-U` option. - -This option works on each installation method described above. - -```bash -$ pip install -U HttpRunner -$ easy_install -U HttpRunner -$ pip install -U git+https://github.com/HttpRunner/HttpRunner.git#egg=HttpRunner -``` - -## Check Installation - -When HttpRunner is installed, a **httprunner** (**hrun** for short) command should be available in your shell (if you're not using -virtualenv—which you should—make sure your python script directory is on your path). - -To see `HttpRunner` version: - -```bash -$ httprunner -V # same as: hrun -V -HttpRunner version: 0.8.1b -PyUnitReport version: 0.1.3b -``` - -To see available options, run: - -```bash -$ httprunner -h # same as: hrun -h -usage: main-debug.py [-h] [-V] [--no-html-report] - [--html-report-name HTML_REPORT_NAME] - [--html-report-template HTML_REPORT_TEMPLATE] - [--log-level LOG_LEVEL] [--log-file LOG_FILE] - [--dot-env-path DOT_ENV_PATH] [--failfast] - [--startproject STARTPROJECT] - [--validate [VALIDATE [VALIDATE ...]]] - [--prettify [PRETTIFY [PRETTIFY ...]]] - [testcase_paths [testcase_paths ...]] - -One-stop solution for HTTP(S) testing. - -positional arguments: - testcase_paths testcase file path - -optional arguments: - -h, --help show this help message and exit - -V, --version show version - --no-html-report do not generate html report. - --html-report-name HTML_REPORT_NAME - specify html report name, only effective when - generating html report. - --html-report-template HTML_REPORT_TEMPLATE - specify html report template path. - --log-level LOG_LEVEL - Specify logging level, default is INFO. - --log-file LOG_FILE Write logs to specified file path. - --dot-env-path DOT_ENV_PATH - Specify .env file path, which is useful for keeping - sensitive data. - --failfast Stop the test run on the first error or failure. - --startproject STARTPROJECT - Specify new project name. - --validate [VALIDATE [VALIDATE ...]] - Validate JSON testcase format. - --prettify [PRETTIFY [PRETTIFY ...]] - Prettify JSON testcase format. -``` - -## Supported Python Versions - -HttpRunner supports Python 2.7, 3.4, 3.5, and 3.6. And we strongly recommend you to use `Python 3.6`. - -`HttpRunner` has been tested on `macOS`, `Linux` and `Windows` platforms. - - -[PyPI]: https://pypi.python.org/pypi diff --git a/docs/Introduction.md b/docs/Introduction.md deleted file mode 100644 index dc65f2ca..00000000 --- a/docs/Introduction.md +++ /dev/null @@ -1,28 +0,0 @@ -# Introduction - -## Design Philosophy - -Take full reuse of Python's existing powerful libraries: [`Requests`][requests], [`unittest`][unittest] and [`Locust`][Locust]. And achieve the goal of API automation test, production environment monitoring, and API performance test, with a concise and elegant manner. - -## Key Features - -- Inherit all powerful features of [`Requests`][requests], just have fun to handle HTTP in human way. -- Define testcases in YAML or JSON format in concise and elegant manner. -- Supports `function`/`variable`/`extract`/`validate` mechanisms to create full test scenarios. -- With `debugtalk.py` plugin, module functions can be auto-discovered in recursive upward directories. -- Testcases can be run in diverse ways, with single testcase, multiple testcases, or entire project folder. -- Test report is concise and clear, with detailed log records. See [`PyUnitReport`][PyUnitReport]. -- With reuse of [`Locust`][Locust], you can run performance test without extra work. -- CLI command supported, perfect combination with [Jenkins][Jenkins]. - -## Learn more - -You can read this [blog][HttpRunner-blog] to learn more about the background and initial thoughts of `HttpRunner`. - - -[requests]: http://docs.python-requests.org/en/master/ -[unittest]: https://docs.python.org/3/library/unittest.html -[Locust]: http://locust.io/ -[PyUnitReport]: https://github.com/HttpRunner/PyUnitReport -[Jenkins]: https://jenkins.io/index.html -[HttpRunner-blog]: http://debugtalk.com/post/ApiTestEngine-api-test-best-practice/ diff --git a/docs/dev-rules.md b/docs/dev-rules.md deleted file mode 100644 index f9dfb589..00000000 --- a/docs/dev-rules.md +++ /dev/null @@ -1,47 +0,0 @@ - -## 版本号（Version） - -从 2.0 版本开始，HttpRunner 开始使用 [`Semantic Versioning`][SemVer] 版本号机制。该机制由 GitHub 联合创始人 Tom Preston-Werner 编写，当前被广泛采用，遵循该机制也可以更好地与开源生态统一，避免出现 “dependency hell” 的情况。 - -具体地，HttpRunner 将采用 `MAJOR.MINOR.PATCH` 的版本号机制。 - -- MAJOR: 重大版本升级并出现前后版本不兼容时加 1 -- MINOR: 大版本内新增功能并且保持版本内兼容性时加 1 -- PATCH: 功能迭代过程中进行问题修复（bugfix）时加 1 - -当然，在实际迭代开发过程中，肯定也不会每次提交（commit）都对 PATCH 加 1；在遵循如上主体原则的前提下，也会根据需要，在版本号后面添加先行版本号（-alpha/beta/rc）或版本编译元数据（+20190101）作为延伸。 - -## 分支策略 - -HttpRunner 的开发分支策略采用 GitHub Flow。 - -![](images/github-flow.png) - -## 提交信息（Commit Message） - -代码提交的注释信息遵循如下格式规范： - -```xml -(): - - - -