altadata 0.2.0

Python library for the ALTADATA API

ALTADATA Python library provides convenient access to the ALTADATA API from applications written in the Python language. With this Python library, developers can build applications around the ALTADATA API without having to deal with accessing and managing requests and responses.

Overview

• Installation

• Retrieving Data

• Documentation

• License

Installation

pip install altadata

Retrieving Data

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

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 (v0.23 or above) to work.

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.

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

Optionally, build documentation from the docs/ folder

pip install sphinx
cd docs
make html

License

altadata-python is under MIT license. See the LICENSE file for more info.