Metadata-Version: 1.0
Name: coindata
Version: 1.3
Summary: Historical data manager for cryptos.
Home-page: https://github.com/anaxilaus/coindata
Author: Anaxilaus
Author-email: UNKNOWN
License: UNKNOWN
Description: Coindata
        ========
        |PyPI|
        |Python|
        |Build Status|
        |License|
        
        Historical data all cryptocurrencies.
        
        Use it for machine learning, vector prediction or for whatever you like. Be my guest.
        
        Install
        -------
        
        Install with pip or clone, both works.
        
        .. code:: bash
        
            $ git clone https://github.com/Anaxilaus/coindata
            $ python coindata/setup.py install
            
        or just do ``pip install coindata``
        
        Setup installs requirements itself. Requirements are beautifulsoup4 and requests. 
        
        Usage
        -----
        
        Cache with ``cache``
        ------------------------------
        
        .. code:: python
        
            >>> coindata.cache('xrp')
        
        Access data through ``get``
        ---------------------------
        
        .. code:: python
        
            >>> coindata.get('RIPPLE')
                [
                  [Beginning of the time]
                  . 
                  .
                  .
                  ['Date': string,
                   'Open*': float,
                   'High': float,
                   'Low': float,
                   'Close**': float,
                   'Volume': float,
                   'Market Cap': float,
                   # additional info below #
                   'date': datetime.object,
                   'circulation': decimal,
                   'change': float]
                   . 
                   .
                   .
                  [Today]
                ]
                
        ``Note:`` Any form of input is legit: ``xrp = XRP = ripple = RIPPLE``
        
        File structure:
        ---------------
        
        ::
        
            source-code:
                coindata:
                    cache:
                        CSV files
                    tickers:
                        JSON files
        
        
        ``Read documentation at code for a lot more functionality``
        
        Important Notes
        ---------------
        
        ``+ Symbol, name and case doesn't matter.``
        
        ::
        
            btc = BTC = bitcoin = BITCOIN
        
        ``+ Based on USD.``
        
        ``+ Date notation is ISO8601 in CSV files.``
        
        .. code:: python
        
            >>> coindata.ISO8601
            "%Y-%m-%d"
        
        
        Give this a star this if you feel this helped you. Contributions always welcome.
        
        .. |PyPI| image:: https://badge.fury.io/py/coindata.svg
            :target: https://badge.fury.io/py/coindata
        .. |Build Status| image:: https://travis-ci.org/Anaxilaus/coindata.svg?branch=master
            :target: https://travis-ci.org/Anaxilaus/coindata
        .. |License| image:: https://img.shields.io/badge/license-MIT-green.svg
            :target: https://github.com/Anaxilaus/coindata/blob/master/LICENSE
        .. |Python| image:: https://img.shields.io/badge/Python-3.5|3.6|3.7-blue.svg
            :target: https://github.com/Anaxilaus/coindata/blob/master/.travis.yml
        
        
        History
        =======
        
        1.3 (2019-03-22)
        ----------------
        
        - Refactor snapshot.py to cache.py
        - Migrate from snapshot logic to single caching
        - Update documentation
        - Update parsing for coinmarketcap's html template change
        - Add test case
        
        1.2 (2019-01-28)
        ----------------
        
        - Update snapshot.py
            - Align with documentation by refactoring take_snapshot to take
            - Add docstrings to take
        - Handle first snapshot by giving warnings
        
        
        1.1 (2019-01-27)
        ----------------
        
        - Major update to data manager
            - Refactor main.py to request.py
            - Add snapshot.py and parser.py
            - Update documentation
        
        
        1.0 (????-??-??)
        ----------------
        
        - First release
        
        
Platform: UNKNOWN
