Metadata-Version: 2.1
Name: getBitMEXData
Version: 0.0.1
Summary: Utility to download bitMEX price data
Home-page: https://github.com/maliky/getBitmexData
Author: Malik Koné
Author-email: malikykone@gmail.com
License: UNKNOWN
Description: Get BitMex Data
        ===============
        
        This is a small utility for linux based systems to download or update
        Bitmex historical data in "1m", "5m" or coarser binSizes.
        
        It only requires some of `BitMex api-connectors's
        files <https://github.com/BitMEX/api-connectors>`__ (that I cutomized in
        auth.py) and a few other commonly used python modules such *request* and
        *pandas*.
        
        Please, just check the import section of
        `getBitmexData.py <https://github.com/maliky/getBitmexData/blob/master/getBitmexData.py>`__
        and install the packages you are missing, if any… and preferably in a
        virtual env. I like `pipenv <https://github.com/pypa/pipenv>`__. :)
        
        Licence
        -------
        
        GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
        
        Installation
        ------------
        
        .. code:: bash
        
           git clone git@github.com:maliky/getBitmexData.git
           cd getBitmexData
        
        Or with pip
        
        .. code:: bash
        
           pip install getBitmexData
        
        Usage
        -----
        
        Just run the getBitmexData.py like this for exemple
        
        ::
        
           python getBitmexData.py --startTime "2019-08-01"
           # or if you install with pip
           getBitmexData --startTime "2020-06-01"
        
        Or update an existing file previously downloaded with getBitmexData.py
        (columns of csv file should be the same). It will get the time from the
        last saved record in the file and the bin size from the file name and
        continue from there.
        
        ::
        
           python update_date.py yourBitmexDataFile-1d.csv
        
        Help and other options
        ~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
           python getBitmexData.py -h
        
        .. code:: bash
        
           usage: getBitmexData.py [-h] [--fout FOUT] [--count COUNT] [--pause PAUSE]
                                   [--binSize BINSIZE] [--startTime STARTTIME]
                                   [--endTime ENDTIME] [--live] [--logLevel LOGLEVEL]
        
           An application to download bitmex s data with what ever resolution you need.
        
           optional arguments:
             -h, --help            show this help message and exit
             --fout FOUT, -f FOUT  Name of the csv file where to save the results. (default btxData.csv)
             --count COUNT, -c COUNT
                                   Max number each of records in requests (default 600)
             --pause PAUSE, -p PAUSE
                                   Min time to wait between 2 requests (default 1.2). to avoid overloading the server
             --binSize BINSIZE, -s BINSIZE
                                   Bin size or type requested, or time resolution (default 1d), can also be 1m, 5m, 1h.
             --startTime STARTTIME, -t STARTTIME
                                   Time to start the data collection (default, oldest available 2016-05-05 04:00:00 'UTC'). Check time zones
             --endTime ENDTIME, -e ENDTIME
                                   Time to end the data collection (default, now - 1 unit of chosen resolution)-05-05 04:00:00 'UTC'). Check TZ
             --live, -l            If present use LIVE keys to get the data else use the test site.
             --logLevel LOGLEVEL, -L LOGLEVEL
                                   set the log level
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: French
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: packaging
Provides-Extra: test
