Metadata-Version: 1.1
Name: bitmex_websocket
Version: 0.1.126
Summary: Bitmex websocket API
Home-page: https://github.com/joliveros/bitmex-websocket
Author: José Oliveros
Author-email: jose.oliveros.1983@gmail.com
License: MIT License
Description: bitmex-websocket
        ================
        .. image:: https://api.travis-ci.org/joliveros/bitmex-websocket.svg?branch=master
            :target: https://travis-ci.org/joliveros/bitmex-websocket
        .. image:: https://requires.io/github/joliveros/bitmex-websocket/requirements.svg?branch=master
            :target: https://requires.io/github/joliveros/bitmex-websocket/requirements?branch=master
        .. image:: https://coveralls.io/repos/joliveros/bitmex-websocket/badge.svg?branch=master
            :target: https://coveralls.io/r/joliveros/bitmex-websocket?branch=master
        
        Install
        -------
        
        .. code-block:: sh
        
            $ pip install bitmex-websocket
        
        Usage
        -----
        
        1. First you should set your `BITMEX_API_KEY` and `BITMEX_API_SECRET`. It can
           be done as follows:
        
        .. code-block:: sh
        
            $ cp .env.example .env
            #  edit .env to reflect your API key and secret
            $ source .env
        
        2. Then in your project you can consume `Instrument` as follows:
        
        .. code-block:: python
        
            from bitmex_websocket import Instrument
            import asyncio
            import websocket
        
            websocket.enableTrace(True)
        
            XBTH17 = Instrument(symbol='XBTH17',
                                # subscribes to all channels by default, here we
                                # limit to just these two
                                channels=['margin', 'orderBook10'],
                                # you must set your environment variables to authenticate
                                # see .env.example
                                shouldAuth=True)
        
            # Get the latest orderbook
            orderBook10 = XBTH17.get_table('orderBook10')
        
            # subscribe to all action events for this instrument
            XBTH17.on('action', lambda x: print("# action message: %s" % x))
        
            loop = asyncio.get_event_loop()
          loop.run_forever()
        
        Examples
        --------
        
        Run example scripts:
        
        .. code-block:: sh
        
            $ RUN_ENV=development python -m examples.example-1
        
        Tests
        -----
        
        Testing is set up using `pytest <http://pytest.org>` and coverage is handled
        with the pytest-cov plugin.
        
        Run your tests with `py.test` in the root directory.
        
        Coverage is ran by default and is set in the `pytest.ini` file.
        To see an html output of coverage open `htmlcov/index.html` after running the tests.
Keywords: bitmex websocket bot cryptocurrency
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
