top-level utility functions to convert DataFrames between Wizata-compatible formats.
All DataFrames used by Wizata must follow a specific format: a Timestamp index and float-compatible data types.
Functions
df_from_csv()
convert bytes representing a CSV file to a pandas DataFrame.
| Name | Type | Default | Description |
|---|---|---|---|
| b_data | bytes | bytes representing a CSV file. | |
| return: pandas DataFrame formatted to Wizata standards. |
import wizata_dsapi
with open("data.csv", "rb") as f:
df = wizata_dsapi.df_from_csv(f.read())df_from_dict()
convert a dict into a valid Wizata dataframe.
| Name | Type | Default | Description |
|---|---|---|---|
| df_dict | dict | dataframe dictionary. | |
| return: pandas DataFrame. |
df_from_json()
convert a dictionary dataframe using JSON convention into a pandas DataFrame. Dataframe must contain a timestamp column and be compatible to float data types.
| Name | Type | Default | Description |
|---|---|---|---|
| json | JSON formatted dataframe. | ||
| return: pandas DataFrame. |
df_to_csv()
convert a DataFrame to a strongly formatted CSV as bytes.
| Name | Type | Default | Description |
|---|---|---|---|
| df | pandas.DataFrame | pandas DataFrame compatible with Wizata standards. | |
| return: bytes containing the full CSV file. |
df_to_dict()
convert a DataFrame to a dictionary.
| Name | Type | Default | Description |
|---|---|---|---|
| df | pandas.DataFrame | dataframe to format. | |
| format_str | str | default | format to use: 'default' or 'grafana'. |
| return: dictionary representation. |
df_to_json()
convert a pandas DataFrame to a JSON-compatible dictionary. Dataframe must be compatible to Wizata format using Timestamp index and float data types.
| Name | Type | Default | Description |
|---|---|---|---|
| df | pandas.DataFrame | pandas DataFrame to convert. | |
| return: dictionary representing a JSON-compatible dataframe. |
validate()
validate a dataframe format to match supported Wizata format. Raises an error if not valid.
| Name | Type | Default | Description |
|---|---|---|---|
| df | pandas.DataFrame | dataframe to validate. | |
| return: validated and formatted DataFrame. |