example_resource_properties

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()

Generate an example resource properties object.

Returns

ResourceProperties

Outputs a correctly formatted example ResourceProperties object.

Examples

import seedcase_sprout as sp
sp.example_resource_properties()
ResourceProperties(name='example-resource', path='resources/example-resource/data.parquet', type=None, title='Example fake data resource', description='Data from a fake resource on something.', sources=None, licenses=None, format=None, mediatype=None, encoding=None, bytes=None, hash=None, schema=TableSchemaProperties(fields=[FieldProperties(name='id', title='ID', type='integer', format=None, description='Unique identifier for the record.', example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='name', title='Name', type='string', format=None, description='Name of the record.', example=None, constraints=None, categories=None, categories_ordered=None), FieldProperties(name='value', title='Value', type='number', format=None, description='Value of the record.', example=None, constraints=None, categories=None, categories_ordered=None)], fields_match=None, primary_key=['id'], unique_keys=None, foreign_keys=None))