From d420f2af3dc49eff91a688993c6e950fee17cdb6 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Wed, 8 Nov 2017 21:35:49 +0800 Subject: [PATCH] convert README from md to rst --- MANIFEST.in | 2 +- README.md | 39 ------------------------------- README.rst | 54 +++++++++++++++++++++++++++++++++++++++++++ docs/Installation.rst | 2 ++ setup.py | 2 +- 5 files changed, 58 insertions(+), 41 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/MANIFEST.in b/MANIFEST.in index 3d387c34..36c6bd73 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,2 @@ -include README.md +include README.rst include requirements.txt \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index fb02169d..00000000 --- a/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# HttpRunner - -[![license](https://img.shields.io/github/license/HttpRunner/HttpRunner.svg)](https://github.com/HttpRunner/HttpRunner/blob/master/LICENSE) -[![Build Status](https://travis-ci.org/debugtalk/HttpRunner.svg?branch=master)](https://travis-ci.org/HttpRunner/HttpRunner) -[![Coverage Status](https://coveralls.io/repos/github/debugtalk/HttpRunner/badge.svg?branch=master)](https://coveralls.io/github/debugtalk/HttpRunner?branch=master) -[![PyPI](https://img.shields.io/pypi/v/HttpRunner.svg)](https://pypi.python.org/pypi/HttpRunner) -[![PyPI](https://img.shields.io/pypi/pyversions/HttpRunner.svg)](https://pypi.python.org/pypi/HttpRunner) - -New name for `ApiTestEngine`. - -## 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 testset, multiple testsets, 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]. - -## Supported Python Versions - -Python `2.7`, `3.4`, `3.5` and `3.6`. - -`HttpRunner` has been tested on `macOS`, `Linux` and `Windows` platforms. - - -[requests]: http://docs.python-requests.org/en/master/ -[unittest]: https://docs.python.org/3/library/unittest.html -[Locust]: http://locust.io/ -[flask]: http://flask.pocoo.org/ -[PyUnitReport]: https://github.com/debugtalk/PyUnitReport -[Jenkins]: https://jenkins.io/index.html -[quickstart]: docs/quickstart.md \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..924b461b --- /dev/null +++ b/README.rst @@ -0,0 +1,54 @@ +HttpRunner +========== + +.. image:: https://img.shields.io/github/license/HttpRunner/HttpRunner.svg + :target: https://github.com/HttpRunner/HttpRunner/blob/master/LICENSE + +.. image:: https://travis-ci.org/debugtalk/HttpRunner.svg?branch=master + :target: https://travis-ci.org/HttpRunner/HttpRunner + +.. image:: https://coveralls.io/repos/github/debugtalk/HttpRunner/badge.svg?branch=master + :target: https://coveralls.io/github/debugtalk/HttpRunner?branch=master + +.. image:: https://img.shields.io/pypi/v/HttpRunner.svg + :target: https://pypi.python.org/pypi/HttpRunner + +.. image:: https://img.shields.io/pypi/pyversions/HttpRunner.svg + :target: https://pypi.python.org/pypi/HttpRunner + + +New name for ``ApiTestEngine``. + +Design Philosophy +----------------- + +Take full reuse of Python's existing powerful libraries: `Requests`_, `unittest`_ and `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`_, 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 testset, multiple testsets, or entire project folder. +- Test report is concise and clear, with detailed log records. See `PyUnitReport`_. +- With reuse of `Locust`_, you can run performance test without extra work. +- CLI command supported, perfect combination with `Jenkins`_. + +Documentation +------------- + +HttpRunner is rich documented. + +- `User documentation`_ helps you to make the most use of HttpRunner +- `Development process blogs`_ will make you fully understand 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 +.. _User documentation: http://httprunner.readthedocs.io/ +.. _Development process blogs: http://debugtalk.com/tags/ApiTestEngine/ diff --git a/docs/Installation.rst b/docs/Installation.rst index 4ebd96c0..f6a9439c 100644 --- a/docs/Installation.rst +++ b/docs/Installation.rst @@ -70,5 +70,7 @@ 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/setup.py b/setup.py index 58378073..fdb59351 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ import io from httprunner import __version__ from setuptools import find_packages, setup -with io.open("README.md", encoding='utf-8') as f: +with io.open("README.rst", encoding='utf-8') as f: long_description = f.read() install_requires = open("requirements.txt").readlines()