sailor.assetcentral.utils

Module for various utility functions, in particular those related to fetching data from remote oauth endpoints.

exception sailor.assetcentral.utils.AssetcentralRequestValidationError

Bases: Exception

class sailor.assetcentral.utils.AssetcentralEntity(ac_json)

Bases: MasterDataEntity

Common base class for AssetCentral entities.

Parameters

ac_json (dict) –

classmethod get_available_properties()

Return the available properties for this class.

property id

Return the ID of the object.

class sailor.assetcentral.utils.AssetcentralEntitySet(elements)

Bases: MasterDataEntitySet

Baseclass to be used in all Sets of AssetCentral objects.

as_df(columns=None)

Return all information on the objects stored in the MasterDataEntitySet as a pandas dataframe.

columns can be specified to select the columns (and their order) for the DataFrame.

Parameters

columns (Optional[Iterable[str]]) –

filter(**kwargs)

Select a subset of the collection based on named filter criteria for the attributes of the elements.

All keyword arguments are concatenated as filters with OR operator, i.e., only one of the supplied filters must match for an entity to be selected.

Returns a new AssetcentralEntitySet object.

Return type

MasterDataEntitySet

plot_distribution(by=None, fill=None, dropna=False)

Plot the distribution of elements of a MasterDataEntitySet based on their properties.

This effectively creates a histogram with the number of elements per group on the y-axis, and the group (given by the by parameter) on the x-axis. Additionally, the fill colour of the bar can be used to distinguish a second dimension.