Skip to content

Commit

Permalink
Added metadata in table schema
Browse files Browse the repository at this point in the history
  • Loading branch information
roll committed Jun 25, 2024
1 parent a454a68 commit fbced86
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions dplib/models/schema/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

from ... import settings, types
from ...system import Model
from ..contributor import Contributor
from ..field import IField
from ..missingValues import IMissingValues
from .foreignKey import ForeignKey
Expand All @@ -21,6 +22,11 @@ class Schema(Model):
)
"""A profile URL"""

name: Optional[str] = None
"""
A simple name or identifier as for Data Package
"""

title: Optional[str] = None
"""
A string providing a title or one sentence description for this schema
Expand All @@ -32,6 +38,31 @@ class Schema(Model):
this also allows for simple plain text as plain text is itself valid markdown.
"""

homepage: Optional[str] = None
"""
A URL for the home on the web that is related to this data package.
"""

keywords: List[str] = []
"""
The `keywords` property is a list of short keywords related to the schema.
"""

examples: List[dict[str, str]] = []
"""
The `examples` property contains links to example data resources.
"""

version: Optional[str] = None
"""
The `version` property stores the version of the schema
"""

contributors: List[Contributor] = []
"""
The people or organizations who contributed to this Table Schema.
"""

fields: List[IField] = []
"""
List of fields in the table schema
Expand Down

0 comments on commit fbced86

Please sign in to comment.