Function-based API

Standalone functions for dataset operations.

Overview

The function-based API provides standalone functions for common operations. These functions internally use HuwiseDataset but offer a simpler interface for straightforward tasks.

Recommendation

For complex workflows or when working with multiple fields, consider using HuwiseDataset directly for better type safety and method chaining.

Usage

Getters

from huwise_utils_py import (
    create_dataset,
    delete_dataset,
    get_dataset_title,
    get_dataset_description,
    get_dataset_keywords,
    get_dataset_language,
    get_dataset_publisher,
    get_dataset_theme,
    get_dataset_license,
    get_dataset_metadata,
    get_number_of_datasets,
    get_all_dataset_ids,
    # New DCAT-AP-CH getters
    get_dataset_dcat_ap_ch_rights,
    get_dataset_dcat_ap_ch_license,
    # New DCAT getters
    get_dataset_created,
    get_dataset_issued,
    get_dataset_creator,
    get_dataset_contributor,
    get_dataset_contact_name,
    get_dataset_contact_email,
    get_dataset_accrualperiodicity,
    get_dataset_relation,
    # New default template getters
    get_dataset_modified,
    get_dataset_geographic_reference,
    get_dataset_custom_field,
    get_dataset_tags,
)

# Get metadata by dataset ID
title = get_dataset_title(dataset_id="100123")
description = get_dataset_description(dataset_id="100123")

# Get all metadata
metadata = get_dataset_metadata(dataset_id="100123")

# Get dataset counts and IDs
count = get_number_of_datasets()
ids = get_all_dataset_ids()

# DCAT-AP-CH fields
rights = get_dataset_dcat_ap_ch_rights(dataset_id="100123")
dcat_license = get_dataset_dcat_ap_ch_license(dataset_id="100123")

# DCAT fields
creator = get_dataset_creator(dataset_id="100123")
contact = get_dataset_contact_name(dataset_id="100123")
issued = get_dataset_issued(dataset_id="100123")

# Default template fields
modified = get_dataset_modified(dataset_id="100123")
geo_refs = get_dataset_geographic_reference(dataset_id="100123")
tags = get_dataset_tags(dataset_id="100123")

# Custom template fields
publishing_org = get_dataset_custom_field("publizierende_organisation", dataset_id="100123")

# Create a new dataset
created_dataset = create_dataset(
    metadata={"default": {"title": {"value": "New Dataset"}}},
    dataset_id="new-dataset",
    resource_source_url="https://data-bs.ch/stata/fgi/stac/AFBA_Abfuhrzonen.geojson",
    resource_title="new-dataset.geojson",
)

# Easier create: metadata is optional
created_dataset_2 = create_dataset(
    dataset_id="new-dataset-2",
    title="New Dataset 2",
)

# Delete a dataset by ID or UID
delete_dataset(dataset_id="new-dataset")

Setters

from huwise_utils_py import (
    append_dataset_field_configuration,
    delete_dataset,
    delete_dataset_resource,
    delete_dataset_field_configuration,
    set_dataset_title,
    set_dataset_description,
    set_dataset_keywords,
    set_dataset_language,
    set_dataset_publisher,
    set_dataset_theme,
    set_dataset_license,
    set_dataset_public,
    # New DCAT-AP-CH setters
    set_dataset_dcat_ap_ch_rights,
    set_dataset_dcat_ap_ch_license,
    # New DCAT setters
    set_dataset_created,
    set_dataset_issued,
    set_dataset_creator,
    set_dataset_contributor,
    set_dataset_contact_name,
    set_dataset_contact_email,
    set_dataset_accrualperiodicity,
    set_dataset_relation,
    # New default template setters
    set_dataset_modified,
    set_dataset_geographic_reference,
    set_dataset_custom_field,
    set_dataset_tags,
    list_dataset_resources,
    update_dataset_configuration,
    update_dataset_field_configuration,
    upsert_dataset_resource_http,
)

# Set metadata (publishes by default)
set_dataset_title("New Title", dataset_id="100123")

# Set without publishing
set_dataset_title("New Title", dataset_id="100123", publish=False)

# Publish/unpublish
set_dataset_public(dataset_id="100123", should_be_public=True)
set_dataset_public(dataset_id="100123", should_be_public=False)

# DCAT-AP-CH fields
set_dataset_dcat_ap_ch_rights(
    "NonCommercialAllowed-CommercialAllowed-ReferenceRequired",
    dataset_id="100123",
)
set_dataset_dcat_ap_ch_license("terms_by", dataset_id="100123")

# Modified date with companion flags
set_dataset_modified(
    "2024-06-01T12:00:00Z",
    dataset_id="100123",
    updates_on_metadata_change=True,
    updates_on_data_change=False,
)

# Set custom fields (custom.*)
set_dataset_custom_field(
    "publizierende_organisation",
    "Open Data Basel-Stadt",
    dataset_id="100123",
)
set_dataset_custom_field(
    "geodaten_modellbeschreibung",
    "Vektormodell gemäss kantonalem Schema v2.",
    dataset_id="100123",
    publish=False,
)

# Set tags (default.tags)
set_dataset_tags(
    ["opendata.swiss", "transport"],
    dataset_id="100123",
    publish=False,
)

# Update dataset-level configuration
update_dataset_configuration(
    dataset_id="renamed-id",
    is_restricted=True,
    target_dataset_id="100123",
)

# Manage dataset field configuration processors
processor = append_dataset_field_configuration(
    {
        "type": "rename",
        "label": "Rename field",
        "from_name": "old_name",
        "to_name": "new_name",
    },
    dataset_id="100123",
)

update_dataset_field_configuration(
    processor["uid"],
    {
        "type": "rename",
        "label": "Rename field (updated)",
        "from_name": "old_name",
        "to_name": "new_name",
    },
    dataset_id="100123",
)

delete_dataset_field_configuration(processor["uid"], dataset_id="100123")

# Upsert resource (idempotent create/update)
resource = upsert_dataset_resource_http(
    dataset_id="100095stac",
    source_url="https://data-bs.ch/stata/fgi/stac/AFBA_Abfuhrzonen.geojson",
    title="100095stac.geojson",
)

# List and delete resources
resources = list_dataset_resources(dataset_id="100095stac")
delete_dataset_resource(resource["uid"], dataset_id="100095stac")

# Delete a dataset by ID or UID
delete_dataset(dataset_id="100123")

Template assumptions and publish behavior

set_dataset_custom_field() and get_dataset_custom_field() operate on custom.<field_key>. set_dataset_tags() and get_dataset_tags() operate on default.tags.

These fields must exist in your Huwise domain metadata template. If they do not exist, the API returns a metadata field error.

All setter helpers default to publish=True. For multiple updates, use publish=False for intermediate calls and publish only once at the end.

Comparison with HuwiseDataset

# Function-based approach
from huwise_utils_py import get_dataset_title, set_dataset_title

title = get_dataset_title(dataset_id="100123")
set_dataset_title("New Title", dataset_id="100123")
set_dataset_description("Desc", dataset_id="100123")

# HuwiseDataset approach (recommended for multiple operations)
from huwise_utils_py import HuwiseDataset

dataset = HuwiseDataset.from_id("100123")
title = dataset.get_title()
dataset.set_title("New Title", publish=False).set_description("Desc").publish()

Available Functions

Getter Function Catalog

Function	Description
`get_all_dataset_ids()`	Get all dataset IDs
`get_number_of_datasets()`	Get total dataset count
`get_dataset_metadata()`	Get full metadata
`get_dataset_title()`	Get dataset title
`get_dataset_description()`	Get dataset description
`get_dataset_keywords()`	Get dataset keywords
`get_dataset_language()`	Get dataset language
`get_dataset_publisher()`	Get dataset publisher
`get_dataset_theme()`	Get dataset theme
`get_dataset_license()`	Get dataset license
`get_dataset_custom_view()`	Get custom view config
`get_dataset_dcat_ap_ch_rights()`	Get DCAT-AP-CH rights statement
`get_dataset_dcat_ap_ch_license()`	Get DCAT-AP-CH license code
`get_dataset_created()`	Get creation date (`dcat.created`)
`get_dataset_issued()`	Get publication date (`dcat.issued`)
`get_dataset_creator()`	Get dataset creator
`get_dataset_contributor()`	Get dataset contributor
`get_dataset_contact_name()`	Get contact name
`get_dataset_contact_email()`	Get contact email
`get_dataset_accrualperiodicity()`	Get accrual periodicity (EU frequency URI)
`get_dataset_relation()`	Get relation URL
`get_dataset_modified()`	Get last-modified date (`default.modified`)
`get_dataset_geographic_reference()`	Get geographic reference codes
`get_dataset_custom_field()`	Get one field from the `custom` template
`get_dataset_tags()`	Get tags from `default.tags`
`get_dataset_metadata_temporal_period()`	Get temporal coverage
`get_template_metadata()`	Get template-specific metadata
`list_dataset_field_configurations()`	List dataset field configuration processors
`get_dataset_field_configuration()`	Get one dataset field configuration processor
`list_dataset_resources()`	List dataset resources

Setter Function Catalog

Function	Description
`set_dataset_public()`	Publish/unpublish dataset
`create_dataset()`	Create a new dataset and return a `HuwiseDataset` instance
`delete_dataset()`	Delete a dataset by `dataset_id` or `dataset_uid`
`set_dataset_title()`	Set dataset title
`set_dataset_description()`	Set dataset description
`set_dataset_keywords()`	Set dataset keywords
`set_dataset_language()`	Set dataset language
`set_dataset_publisher()`	Set dataset publisher
`set_dataset_theme()`	Set dataset theme
`set_dataset_license()`	Set dataset license (supports optional `license_name` for the human-readable string)
`set_dataset_dcat_ap_ch_rights()`	Set DCAT-AP-CH rights statement
`set_dataset_dcat_ap_ch_license()`	Set DCAT-AP-CH license code
`set_dataset_created()`	Set creation date (`dcat.created`)
`set_dataset_issued()`	Set publication date (`dcat.issued`)
`set_dataset_creator()`	Set dataset creator
`set_dataset_contributor()`	Set dataset contributor
`set_dataset_contact_name()`	Set contact name
`set_dataset_contact_email()`	Set contact email
`set_dataset_accrualperiodicity()`	Set accrual periodicity (EU frequency URI)
`set_dataset_relation()`	Set relation URL
`set_dataset_geographic_reference()`	Set geographic reference codes
`set_dataset_custom_field()`	Set one field in the `custom` template
`set_dataset_tags()`	Set tags in `default.tags`
`set_dataset_modified()`	Set last-modified date with optional companion flags
`set_dataset_metadata_temporal_period()`	Set both dates
`set_dataset_metadata_temporal_coverage_start_date()`	Set start date
`set_dataset_metadata_temporal_coverage_end_date()`	Set end date
`set_template_metadata()`	Set template-specific field
`update_dataset_configuration()`	Update dataset-level configuration (`dataset_id`, `is_restricted`, `default_security`)
`append_dataset_field_configuration()`	Append a new dataset field configuration processor
`update_dataset_field_configuration()`	Update an existing dataset field configuration processor
`delete_dataset_field_configuration()`	Delete a dataset field configuration processor
`upsert_dataset_resource_http()`	Idempotently create or update an HTTP dataset resource
`delete_dataset_resource()`	Delete a dataset resource by UID