ckanapi_harvesters.builder.example package

Submodules

ckanapi_harvesters.builder.example.builder_example module

Function to load the example package

ckanapi_harvesters.builder.example.builder_example.load_example_package() → BuilderPackageWithHarvesters

ckanapi_harvesters.builder.example.builder_example_aux_fun module

Auxiliary functions for package upload/download example

ckanapi_harvesters.builder.example.builder_example_aux_fun.users_download(df_download: DataFrame, *, fields: Dict[str, CkanField], file_query: str = None, **kwargs) → DataFrame | List[dict]

ckanapi_harvesters.builder.example.builder_example_aux_fun.users_upload(df_local: DataFrame | List[dict], *, fields: Dict[str, CkanField], file_name: str = None, total_lines_read: int = None, **kwargs) → DataFrame | List[dict]

ckanapi_harvesters.builder.example.builder_example_download module

Example code to download the builder example from a CKAN server

ckanapi_harvesters.builder.example.builder_example_download.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_generate_data module

Code to generate sample data for the dataset example

ckanapi_harvesters.builder.example.builder_example_generate_data.degrees_DMS(lat: str, lon: str) → Tuple[float, float]: Returns angles for GPS coordinates in the form :param lat: example: 48° 51’ 12.24845” N :param lon: example: 2° 20’ 55.62563” E :return:

ckanapi_harvesters.builder.example.builder_example_generate_data.run()

ckanapi_harvesters.builder.example.builder_example_patch_upload module

Example code to upload the builder example to a CKAN server

ckanapi_harvesters.builder.example.builder_example_patch_upload.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_policy module

Tests to perform after the example package was uploaded

ckanapi_harvesters.builder.example.builder_example_policy.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_sample_dataset module

Upload a sample dataset from the example package (needs to be online)

Samples are used to expose a portion of a dataset to a user, which can be publicly exposed, so he can contact the data provider to demand full access.

ckanapi_harvesters.builder.example.builder_example_sample_dataset.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_test_sql module

Tests to perform after the example package was uploaded

ckanapi_harvesters.builder.example.builder_example_test_sql.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_tests module

Call existing tests

ckanapi_harvesters.builder.example.builder_example_tests.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_tests_dev module

Tests to perform after the example package was uploaded

ckanapi_harvesters.builder.example.builder_example_tests_dev.run(ckan: CkanApiManage = None)

ckanapi_harvesters.builder.example.builder_example_tests_dev.traces_chunks_generator(chunksize: int)

ckanapi_harvesters.builder.example.builder_example_tests_offline module

Tests to perform after the example package was uploaded

ckanapi_harvesters.builder.example.builder_example_tests_offline.run()

Module contents

Section of the package dedicated to the initialization of a CKAN package