Metadata-Version: 2.1
Name: coindata
Version: 1.2
Summary: Historical data manager for cryptos.
Home-page: https://github.com/anaxilaus/coindata
Author: Anaxilaus
Author-email: UNKNOWN
License: UNKNOWN
Platform: UNKNOWN
Requires-Dist: requests (>=2.18.4)
Requires-Dist: beautifulsoup4 (>=4.6.0)

Coindata
========
|PyPI|
|Python|
|Build Status|
|License|

Daily historical data of all time to date of hundreds of 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

    $ pip install coindata
    ---- or ----
    $ git clone git@github.com:anaxilaus/coindata
    $ python coindata/setup.py install

Setup installs requirements itself. Requirements are beautifulsoup4 and requests. 

Usage with Modules
------------------

There are only 2 modules you will use:

::

    snapshot
    parser

Update cache with ``snapshot``
------------------------------

.. code:: python

    >>> coindata.snapshot.take()

Get data with ``parser``
------------------------

.. code:: python

    >>> coindata.parser.vector_of('btc')
        [
          [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]
        ]


How this works?
---------------
Basically, this program parses daily historical data of all time from coinmarketcap's website, stores at CSV files through running a "snapshot." After you request a data vector, calculates what coinmarketcap doesn't give you, like circulation supply, daily percentage change, datetime object etc. and returns the vector.

If you want, you can use .csv files seperately.

File structure:
---------------

::

    source-code:
        coindata:
            snapshots:
                latest-snapshot:
                    CSV files
            tickers:
                JSON files


`Get documentation for more with built-in help() or read the code.`

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.

Also, if you want to buy a beer:

::

    BTC: 16XwDdxUaphSX4yWDTTiSfNy2dTyEZ5MLy
    ETH: 0x35F4B63f7eBBB2E6080F7f9f797A068004faf323
    LTC: LdukNLZqzeEvvFYMw98L9Rj8AYvP86BhEe


.. |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.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


