LicenseProperties

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.LicenseProperties(
    self,
    name: str | None = None,
    path: str | None = None,
    title: str | None = None,
)

The license(s) under which the package or resource is provided.

Creates a dataclass object with all the necessary properties for a license, so that it can be added to the licenses field of a PackageProperties object.

Attributes

name : str | None

Must be an Open Definition license identifier, see http://licenses.opendefinition.org/

path : str | None

A fully qualified URL, or a POSIX file path.

title : str | None

A human-readable title.

Examples

import seedcase_sprout.core as sp
print(sp.LicenseProperties())

LicenseProperties(name=None, path=None, title=None)

Methods

Name	Description
default	Creates a LicenseProperties object with default values.

default

core.LicenseProperties.default()

Creates a LicenseProperties object with default values.

Returns

Self

A LicenseProperties object with default values.