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/HttpRunner/HttpRunner.svg?branch=master
    :target: https://travis-ci.org/HttpRunner/HttpRunner

.. image:: https://coveralls.io/repos/github/HttpRunner/HttpRunner/badge.svg?branch=master
    :target: https://coveralls.io/github/HttpRunner/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


Former name: ``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.
- Record and generate testcases with ``HAR`` support. see `har2case`_.
- 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 in English`_
- `中文用户使用手册`_
- `开发历程记录博客`_

Next Step
---------

There are still too many awesome features to be implemented. Recent schedules includes:

- [x] Integrate with Charles and Fiddler: convert `HAR`_ (HTTP Archive) format to YAML testcases.
- [ ] Integrate with Swagger: convert exported API definition of `Swagger`_ to YAML testcases.
- [ ] Integrate with PostMan: convert `Postman Collection Format`_ to YAML testcases.


.. _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 in English: http://httprunner.org/
.. _中文用户使用手册: http://cn.httprunner.org/
.. _开发历程记录博客: http://debugtalk.com/tags/HttpRunner/
.. _HAR: http://httparchive.org/
.. _Swagger: https://swagger.io/
.. _Postman Collection Format: http://blog.getpostman.com/2015/06/05/travelogue-of-postman-collection-format-v2/
.. _har2case: https://github.com/HttpRunner/har2case