Metadata-Version: 2.1
Name: altadata
Version: 0.0.3
Summary: Python library for the ALTADATA API
Home-page: https://github.com/altabering/altadata-python
Author: ALTADATA
Author-email: contact@altadata.io
License: MIT
Keywords: altadata api data marketplace
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >= 3.5
Description-Content-Type: text/x-rst
Requires-Dist: requests (>=2.7.0)
Provides-Extra: pandas
Requires-Dist: pandas (>=0.21.0) ; extra == 'pandas'

--------------------------
ALTADATA Python Client
--------------------------

.. image:: https://github.com/altabering/altadata-python/workflows/build/badge.svg
    :target: https://github.com/altabering/altadata-python/actions

.. image:: https://badge.fury.io/py/altadata.svg
    :target: https://badge.fury.io/py/altadata

|

ALTADATA Python library provides convenient access to the ALTADATA API from
applications written in the Python language.

.. contents:: **Overview**
    :depth: 2

Installation
==================

.. code-block::

    pip install altadata


Retrieving Data
==================

You can get the entire data with the code below. This function returns List of dict by default.

.. code:: python

    client = AltaDataAPI(YOUR_API_KEY)
    data = client.get_data(PRODUCT_CODE).load()


We currently have pandas dataframe support in the library. Users can optionally retrieve their datasets as pandas dataframe.
If **dataframe_functionality** parameter is True function returns pandas dataframe.

``Note:`` This functionality requires `pandas <https://github.com/pandas-dev/pandas>`_ (v0.21 or above) to work.

.. code:: python

    client = AltaDataAPI(api_key=YOUR_API_KEY, dataframe_functionality=True)
    data = client.get_data(PRODUCT_CODE).load()

You can get data with using various conditions. 

.. code:: python

    client = AltaDataAPI(YOUR_API_KEY)
    data = client.get_data(PRODUCT_CODE)\
            .equal(condition_column=COLUMN_NAME, condition_value=CONDITION_VALUE)\
            .sort(order_column=COLUMN_NAME, order_method="desc")\
            .load()


Documentation
==================

Read the documentation online at `altadata-python.rtfd.io <https://altadata-python.rtfd.io>`_

Optionally, build documentation from the ``docs/`` folder

.. code-block::

    pip install sphinx
    cd docs
    make html


License
==================

altadata-python is under MIT license. See the `LICENSE <LICENSE>`_ file for more info.


