ContributorProperties

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.ContributorProperties(
    self,
    title: str | None = None,
    path: str | None = None,
    email: str | None = None,
    given_name: str | None = None,
    family_name: str | None = None,
    organization: str | None = None,
    roles: list[str] | None = None,
)

The people or organizations who contributed to this data package.

Creates a dataclass object with all the necessary properties for a contributor. This would be given in the contributors field of a PackageProperties object.

Attributes

title : str | None

The name of the contributor.

path : str | None

A fully qualified URL pointing to a relevant location online for the contributor.

email : str | None

An email address.

given_name : str | None

The name a person has been given, if the contributor is a person.

family_name : str | None

The familial name that a person inherits, if the contributor is a person.

organization : str | None

An organizational affiliation for this contributor.

roles : list[str] | None

An array of strings describing the roles of the contributor.

Examples

import seedcase_sprout.core as sp
print(sp.ContributorProperties())
print(sp.ContributorProperties(title="Amir Smith"))
ContributorProperties(title=None, path=None, email=None, given_name=None, family_name=None, organization=None, roles=None)
ContributorProperties(title='Amir Smith', path=None, email=None, given_name=None, family_name=None, organization=None, roles=None)

Methods

Name Description
default Creates a ContributorProperties object with default values.

default

core.ContributorProperties.default()

Creates a ContributorProperties object with default values.

Returns

Self

A ContributorProperties object with default values.