Python SDK: Retrrieve dataframe with specified column header

Hi ​@Jørgen Aarstad ,

Thank you for the request! I’ve passed it along to the relevant team. We’ll follow up as soon as there’s news.

Best regards,
Que Tran

Thank you for taking the time to share this feature idea!

After looking into it, we believe that wrapping the Pandas API for DataFrame.rename(...) falls outside the scope of the SDK. Pandas natively handles this with a high degree of flexibility, and trying to replicate that behavior by adding a new parameter to the method would be unnecessarily cumbersome to maintain and use.

You can already easily achieve your desired result by chaining the Pandas .rename() method directly to the retrieved dataframe.

Here is a quick example of how you can do this:

df = client.time_series.data.retrieve_dataframe(
    external_id=["foo", "bar"], limit=5
).rename(
    columns={"foo": "something", "bar": "else"}
)

To map the name attribute directly:

ts_xids = ['ts-test-123', 'ts-test-234', 'ts-test-345']
tss = client.time_series.retrieve_multiple(external_ids=ts_xids)
df = client.time_series.data.retrieve_dataframe(
    external_id=ts_xids, limit=5
).rename(columns={ts.external_id: ts.name for ts in tss})