trailpack.packing.datapackage_schema

DataPackage metadata schema and interactive builder classes using Pydantic. Provides structured definitions and UI-friendly methods for creating Frictionless Data Package metadata with automatic validation.

Attributes

COMMON_LICENSES
FIELD_TEMPLATES

Classes

Contributor	Contributor information with validation.
ContributorRole	Standard contributor roles.
DataPackageSchema	DataPackage metadata schema definition with UI-friendly methods.
Field	Data field schema definition with validation.
FieldConstraints	Field validation constraints with validation.
FieldType	Supported field types in data packages.
License	License information with automatic validation.
MetaDataBuilder	Interactive builder for creating DataPackage metadata.
Resource	Data resource (file) definition with validation.
Source	Data source information with validation.
Unit	Unit of measurement with QUDT vocabulary support.

Module Contents

class trailpack.packing.datapackage_schema.Contributor

Bases: pydantic.BaseModel

Contributor information with validation.

to_dict() → Dict[str, Any]

Convert to dictionary format, excluding None values.

classmethod validate_email(v)

Basic email validation.

classmethod validate_role(v)

Validate role is from accepted list.

email: str | None

name: str

organization: str | None

role: str

class trailpack.packing.datapackage_schema.ContributorRole

Bases: enum.Enum

Standard contributor roles.

AUTHOR = 'author'

CONTRIBUTOR = 'contributor'

MAINTAINER = 'maintainer'

PUBLISHER = 'publisher'

WRANGLER = 'wrangler'

class trailpack.packing.datapackage_schema.DataPackageSchema

DataPackage metadata schema definition with UI-friendly methods. Provides structure and validation for Frictionless Data Package metadata.

Initialize the schema definition.

_create_field_definitions() → Dict[str, Dict[str, Any]]

Create field definitions for UI generation.

get_all_fields() → List[str]

Get list of all possible field names.

get_field_definition(field_name: str) → Dict[str, Any]

Get UI field definition for a specific field.

get_recommended_fields() → List[str]

Get list of recommended field names.

get_required_fields() → List[str]

Get list of required field names.

validate_package_name(name: str) → tuple[bool, str]

Validate package name format.

validate_url(url: str) → tuple[bool, str]

Validate URL format.

validate_version(version: str) → tuple[bool, str]

Validate semantic version format.

OPTIONAL_FIELDS = ['profile', 'keywords', 'homepage', 'repository', 'image', 'id']

RECOMMENDED_FIELDS = ['description', 'version']

REQUIRED_FIELDS = ['name', 'title', 'resources', 'licenses', 'created', 'contributors', 'sources']

field_definitions

class trailpack.packing.datapackage_schema.Field

Bases: pydantic.BaseModel

Data field schema definition with validation.

to_dict() → Dict[str, Any]

Convert to dictionary format.

classmethod validate_field_type(v)

Validate field type is from accepted list.

validate_numeric_has_unit()

Validate that numeric fields have a unit.

constraints: FieldConstraints | None

description: str | None

name: str

rdf_type: str | None

taxonomy_url: str | None

type: str

unit: Unit | None

class trailpack.packing.datapackage_schema.FieldConstraints

Bases: pydantic.BaseModel

Field validation constraints with validation.

to_dict() → Dict[str, Any]

Convert to dictionary format, excluding None values.

classmethod validate_numeric_constraints(v, info)

Validate numeric constraints.

classmethod validate_pattern(v)

Validate regex pattern.

enum: List[str] | None

maximum: int | float | None

minimum: int | float | None

pattern: str | None

required: bool | None

unique: bool | None

class trailpack.packing.datapackage_schema.FieldType

Bases: enum.Enum

Supported field types in data packages.

BOOLEAN = 'boolean'

DATE = 'date'

DATETIME = 'datetime'

DURATION = 'duration'

INTEGER = 'integer'

NUMBER = 'number'

STRING = 'string'

TIME = 'time'

class trailpack.packing.datapackage_schema.License

Bases: pydantic.BaseModel

License information with automatic validation.

to_dict() → Dict[str, Any]

Convert to dictionary format, excluding None values.

classmethod validate_path_url(v)

Validate URL format.

name: str

path: str | None

title: str | None

class trailpack.packing.datapackage_schema.MetaDataBuilder

Interactive builder for creating DataPackage metadata. Can be used with UI frameworks to collect user input.

Initialize the builder.

add_contributor(name: str, role: str = 'author', email: str | None = None, organization: str | None = None) → MetaDataBuilder

Add contributor information.

add_license(name: str | None = None, title: str | None = None, path: str | None = None) → MetaDataBuilder

Add license information. Defaults to CC-BY-4.0 if no name provided. License name should be a valid SPDX identifier. path should be a valid URL to SPDX license page. See https://spdx.org/licenses/ for common licenses.

add_resource(resource: Resource) → MetaDataBuilder

Add a data resource.

add_source(title: str, path: str | None = None, description: str | None = None) → MetaDataBuilder

Add data source information.

build() → Dict[str, Any]

Build the complete metadata dictionary.

get_current_state() → Dict[str, Any]

Get current builder state for UI display.

get_ui_fields() → Dict[str, Dict[str, Any]]

Get field definitions for UI generation.

set_basic_info(name: str, title: str | None = None, description: str | None = None, version: str | None = None) → MetaDataBuilder

Set basic package information.

set_dates() → MetaDataBuilder

Set creation date to current time

set_keywords(keywords: List[str]) → MetaDataBuilder

Set keywords/tags.

set_links(homepage: str | None = None, repository: str | None = None) → MetaDataBuilder

Set homepage and repository URLs.

set_profile(profile: str) → MetaDataBuilder

Set package profile.

contributors = []

licenses = []

metadata

resources = []

schema

sources = []

class trailpack.packing.datapackage_schema.Resource

Bases: pydantic.BaseModel

Data resource (file) definition with validation.

to_dict() → Dict[str, Any]

Convert to dictionary format.

classmethod validate_encoding(v)

Validate encoding is valid.

classmethod validate_format(v)

Validate format is recognized.

description: str | None

encoding: str

fields: List[Field]

format: str | None

mediatype: str | None

name: str

path: str

primary_key: List[str]

profile: str | None

title: str | None

class trailpack.packing.datapackage_schema.Source

Bases: pydantic.BaseModel

Data source information with validation.

to_dict() → Dict[str, Any]

Convert to dictionary format, excluding None values.

classmethod validate_path(v)

Basic path validation.

description: str | None

path: str | None

title: str

class trailpack.packing.datapackage_schema.Unit

Bases: pydantic.BaseModel

Unit of measurement with QUDT vocabulary support.

to_dict() → Dict[str, Any]

Convert to dictionary format for metadata.

classmethod validate_path_url(v)

Validate URI format.

long_name: str | None

name: str

path: str | None

trailpack.packing.datapackage_schema.COMMON_LICENSES

trailpack.packing.datapackage_schema.FIELD_TEMPLATES