README.rst

   1 BluePill
   2 ========
   3
   4 .. image:: https://img.shields.io/pypi/v/bluepill.svg?maxAge=2592000
   5    :target: https://pypi.python.org/pypi/bluepill
   6
   7 .. image:: https://img.shields.io/travis/SShrike/bluepill.svg?maxAge=2592000
   8    :target: https://travis-ci.org/SShrike/bluepill
   9
  10 .. image:: https://img.shields.io/codecov/c/github/SShrike/bluepill.svg?maxAge=2592000
  11    :target: https://codecov.io/gh/SShrike/bluepill
  12
  13 BluePill is a mock server intended for testing `Matrix <https://matrix.org>`__
  14 Client-Server SDKs.
  15
  16 Python 2.7+ and 3.4+ are supported.
  17
  18 Installation
  19 ------------
  20
  21 Via PyPI:
  22
  23 .. code:: bash
  24
  25   pip install bluepill
  26
  27 From source:
  28
  29 .. code:: bash
  30
  31   git clone https://github.com/SShrike/bluepill.git
  32   cd bluepill
  33   pip install .
  34
  35 Usage
  36 -----
  37
  38 Either run the executable from the command line or use the Python API:
  39
  40 .. code:: python
  41
  42   from bluepill.server import BackgroundServer
  43
  44   server = BackgroundServer()
  45   server.start()  # Starts the server in a background process.
  46   server.stop()  # Stops the server.