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 🚧

core.PackageProperties

core.PackageProperties(
    self,
    name=None,
    id=None,
    title=None,
    description=None,
    homepage=None,
    version=None,
    created=None,
    contributors=None,
    keywords=None,
    image=None,
    licenses=None,
    resources=None,
    sources=None,
)

A data package.

A simple container format for describing a coherent collection of data in a single “package”. It provides the basis for convenient delivery, installation and management of datasets.

Attributes

name : str | None: A simple name or identifier to be used for this package. Should consist only of lowercase English alphanumeric characters plus characters in .-_.
id : str | None: The unique identifier of this package.
title : str | None: A human-readable title.
description : str | None: A text description. Markdown is encouraged.
homepage : str | None: The home on the web that is related to this package.
version : str | None: A version string identifying the version of this package.
created : str | None: The datetime on which this package was created.
contributors : list[ContributorProperties] | None: The people or organizations who contributed to this package.
keywords : list[str] | None: A list of keywords that describe this package.
image : str | None: An image to represent this package.
licenses : list[LicenseProperties] | None: The license(s) under which this package is published.
resources : list[ResourceProperties] | None: Specifies the data resources in this data package, each compliant with the data resource specification.
sources : list[SourceProperties] | None: The raw sources for this data package.

Methods

Name	Description
default	Creates an instance with default values.

default

core.PackageProperties.default()

Creates an instance with default values.

Returns

: Self: A PackageProperties object with default values