database.resources.packaging#

This script houses functions for packaging the data.

Attributes#

`create_data_dictionary`(metadata_dictionary)	Creates a data dictionary from the metadata.
`create_data_package`()	This function creates a datapackage.
`create_individual_data_packages`()	Creates data packages for each product
`export_data_csv`(dataframe, filename)	Exports the table to a CSV file.
`export_data_dictionaries`(data_dictionary)	Creates individual data dictionaries for each resource.
`generate_dictionaries`()	Calls functions in the required order.
`load_json`(file_path)	Imports the Frictionless JSON datapackage metadata.

database.resources.packaging.create_data_dictionary(metadata_dictionary: dict)#

Creates a data dictionary from the metadata.

Parameters:: metadata_dictionary (dict) – Dictionary of Frictionless JSON metadata.
Returns:: Pandas DataFrame resource schema fields.
Return type:: pd.DataFrame (pd.DataFrame)

database.resources.packaging.create_data_package()#: This function creates a datapackage.

database.resources.packaging.create_individual_data_packages()#

Creates data packages for each product

Note

Parses the data-package directory for pairs of dictionary and data file pairs.

database.resources.packaging.export_data_csv(dataframe: polars.DataFrame, filename: str)#

Exports the table to a CSV file.

Parameters:

Note

Do not include file extensions in the filename.

database.resources.packaging.export_data_dictionaries(data_dictionary: pandas.DataFrame)#

Creates individual data dictionaries for each resource.

Parameters:: data_dictionary (pd.DataFrame) – Data dictionary of all resources.
Returns:: None

database.resources.packaging.generate_dictionaries()#

Calls functions in the required order.

database.resources.packaging.load_json(file_path: str)#

Imports the Frictionless JSON datapackage metadata.

Parameters:: file_path (str) – Filepath to the Frictionless JSON datapackage metadata.
Returns:: Dictionary class of metadata
Return type:: metadata (dict)