example_resource_properties_all_types

Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

example_resource_properties_all_types()

Generate an example resource properties object with all Data Package data types.

Returns

ResourceProperties

Outputs a correctly formatted example ResourceProperties object.

Examples

import seedcase_sprout as sp
sp.example_resource_properties_all_types()

ResourceProperties(name='data', path='resources/data/data.parquet', type=None, title='data', description='My data...', sources=None, licenses=None, format=None, mediatype=None, encoding=None, bytes=None, hash=None, schema=TableSchemaProperties(fields=[FieldProperties(name='my_boolean', title=None, type='boolean', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_integer', title=None, type='integer', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_number', title=None, type='number', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_year', title=None, type='year', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_yearmonth', title=None, type='yearmonth', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_datetime_tz', title=None, type='datetime', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_datetime_no_tz', title=None, type='datetime', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_date', title=None, type='date', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_time', title=None, type='time', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_geopoint', title=None, type='geopoint', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_array', title=None, type='array', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_object', title=None, type='object', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_string', title=None, type='string', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_any', title=None, type='any', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_none', title=None, type=None, format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_duration', title=None, type='duration', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='my_geojson', title=None, type='geojson', format=None, description=None, example=None, constraints=None, categories=None, categories_ordered=None)], fields_match=None, primary_key=None, unique_keys=None, foreign_keys=None))