Metadata-Version: 1.1
Name: libcryptomarket
Version: 0.1.2
Summary: Library for cryptocurrency market information.
Home-page: https://github.com/gavincyi/libcryptomarket
Author: Gavin Chan
Author-email: gavincyi@gmail.com
License: GNU General Public License v3
Description-Content-Type: UNKNOWN
Description: # libcryptomarket: Powerful cryptocurrency market analysis toolkit
        
        ## Objective
        
        The library is for researchers to analysis cryptocurrency in a fast and
        flexible way. Currently there are different source of API to get the
        cryptocurrency market information. The sources are from websites which provides
        a general comparative information among the currencies and from exchanges. The
        target is to normalize the API functions from data source, and let the users
        query the data without pain.
        
        
        ## Prerequisite
        
        Python 3.5+
        
        ## Installation
        
        You can install it via pip for static version
        
        ```
        pip install libcryptomarket
        ```
        
        or development version
        
        ```
        pip install git+https://github.com/libcryptomarket/libcryptomarket.git
        ```
        
        ## Usage
        
        All the query result are converted into pandas Series or DataFrame.
        
        ### Instrument
        
        To get a list of available currencies, run
        
        ```
        from libcryptomarket.instrument import get_instruments
        
        instruments = get_instruments()
        ```
        
        ### Historical
        
        Currently, multiple data sources of historical data are supported. 
        
        For example, for the source of [Cryptocompare](https://www.cryptocompare.com/api/#),
        run
        
        ```
        from datetime import datetime
        from libcryptomarket.historical import get_historical_prices
        
        prices = get_historical_prices(source='cryptocompare',
                                       symbol='LTC/BTC',
                                       exchange='Poloniex',
                                       period="hour",
                                       from_time=datetime(2017, 5, 1),
                                       to_time=datetime(2017, 8, 1))
        ```
        
        Then you can get historical price in ascending order seamlessly, even though
        the limit has exceeded the source limit. The application helps continue
        querying until the data reaches the requirements.
        
        For the source of [Poloniex](https://poloniex.com/support/api/), run
        
        ```
        prices = get_historical_prices(source='Poloniex',
                                       symbol='LTC/BTC',
                                       period="30m",
                                       from_time=datetime(2016, 1, 1),
                                       to_time=datetime(2017, 8, 1))
        ```
        
        ## Contribution
        
        The project is targeting as a core but generic toolkit to query cryptocurrency
        market, so we are happy if you join to contribute and make it better. Please
        do not hesitate to contact us (gavincyi at gmail dot com).
        
        =======
        History
        =======
        
        0.1.0 (2017-11-07)
        ------------------
        
        * First release on PyPI.
        
Keywords: libcryptomarket
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
