TechnoteMetadata

class technote.metadata.model.TechnoteMetadata(*, title, status, canonical_url=None, id=None, series_id=None, date_created=None, date_updated=None, version=None, authors=<factory>, contributors=<factory>, source_repository=None, license_id=None, citation=None, abstract_plain=None)

Bases: object

The domain model for metadata about a technote.

Parameters:

• title (str)

• status (Status)

• canonical_url (str | None, default: None)

• id (str | None, default: None)

• series_id (str | None, default: None)

• date_created (datetime | None, default: None)

• date_updated (datetime | None, default: None)

• version (str | None, default: None)

• authors (list[Person], default: <factory>)

• contributors (list[Contributor], default: <factory>)

• source_repository (SourceRepository | None, default: None)

• license_id (str | None, default: None)

• citation (Citation | None, default: None)

• abstract_plain (str | None, default: None)

Attributes Summary

abstract_plain	The technote's abstract in plain text.
authors	The authors of the technote.
canonical_url	The canonical URL of the technote.
citation	Additional information for citing the technote.
contributors	The additional contributors to the technote.
date_created	The date when the technote was created.
date_updated	The date when the technote was last updated.
id	The institutional identifier for a technote.
license_id	The SPDX license identifier for the technote.
series_id	The identifier for the series the technote belongs to.
source_repository	The source code repository for the technote.
status	The status of the technote.
title	The title of the technote.
version	The version of the technote.

Attributes Documentation

abstract_plain: str | None = None

The technote’s abstract in plain text.

authors: list[Person] = <dataclasses._MISSING_TYPE object>

The authors of the technote.

canonical_url: str | None = None

The canonical URL of the technote.

citation: Citation | None = None

Additional information for citing the technote.

contributors: list[Contributor] = <dataclasses._MISSING_TYPE object>

The additional contributors to the technote.

date_created: datetime | None = None

The date when the technote was created.

date_updated: datetime | None = None

The date when the technote was last updated.

id: str | None = None

The institutional identifier for a technote.

license_id: str | None = None

The SPDX license identifier for the technote.

series_id: str | None = None

The identifier for the series the technote belongs to.

source_repository: SourceRepository | None = None

The source code repository for the technote.

status: Status = <dataclasses._MISSING_TYPE object>

The status of the technote.

title: str = <dataclasses._MISSING_TYPE object>

The title of the technote.

version: str | None = None

The version of the technote.