Updated docs

docs/models/schema.md

@@ -5,10 +5,10 @@ The Table Schema model allows to manipulate a Pydantic model in Python according
 ## Usage
 
 ```python
-from dplib.models import Schema, Field
+from dplib.models import Schema, IntegerField
 
 schema = Schema()
-schema.add_field(Field(name='id', type='integer'))
+schema.add_field(IntegerField(name='id'))
 schema.missingValues = ['-']
 print(schema.to_text(format="json"))
 ```
@@ -28,7 +28,28 @@ print(schema.to_text(format="json"))
 ## Reference
 
 ::: dplib.models.Schema
-::: dplib.models.Field
-::: dplib.models.Constraints
+::: dplib.models.IFieldsMatch
 ::: dplib.models.ForeignKey
 ::: dplib.models.ForeignKeyReference
+::: dplib.models.Field
+::: dplib.models.AnyField
+::: dplib.models.ArrayField
+::: dplib.models.BooleanField
+::: dplib.models.DateField
+::: dplib.models.DatetimeField
+::: dplib.models.DurationField
+::: dplib.models.GeojsonField
+::: dplib.models.GeopointField
+::: dplib.models.IntegerField
+::: dplib.models.ListField
+::: dplib.models.NumberField
+::: dplib.models.ObjectField
+::: dplib.models.StringField
+::: dplib.models.TimeField
+::: dplib.models.YearField
+::: dplib.models.YearmonthField
+::: dplib.models.BaseConstraints
+::: dplib.models.CollectionConstraints
+::: dplib.models.JsonConstraints
+::: dplib.models.StringConstraints
+::: dplib.models.ValueConstraints

dplib/models/__init__.py

@@ -4,5 +4,5 @@
 from .license import License
 from .package import Package
 from .resource import Resource
-from .schema import ForeignKey, ForeignKeyReference, Schema
+from .schema import *
 from .source import Source

dplib/models/field/datatypes/any.py

@@ -9,6 +9,8 @@
 
 
 class AnyField(BaseField):
+    """The field contains values of a unspecified or mixed type."""
+
     type: Literal["any"] = "any"
     format: Optional[Literal["default"]] = None
     constraints: BaseConstraints = pydantic.Field(default_factory=BaseConstraints)

dplib/models/field/datatypes/array.py

@@ -9,6 +9,8 @@
 
 
 class ArrayField(BaseField):
+    """The field contains a valid JSON array."""
+
     type: Literal["array"] = "array"
     format: Optional[Literal["default"]] = None
     constraints: JsonConstraints = pydantic.Field(default_factory=JsonConstraints)

dplib/models/field/datatypes/base.py

@@ -9,7 +9,7 @@
 
 
 class BaseField(Model):
-    """Table Schema Field model"""
+    """Base Field"""
 
     name: Optional[str] = None
     """

dplib/models/field/datatypes/boolean.py

@@ -9,6 +9,8 @@
 
 
 class BooleanField(BaseField):
+    """The field contains boolean (true/false) data."""
+
     type: Literal["boolean"] = "boolean"
     format: Optional[Literal["default"]] = None
     constraints: BaseConstraints = pydantic.Field(default_factory=BaseConstraints)

dplib/models/field/datatypes/date.py

@@ -9,6 +9,8 @@
 
 
 class DateField(BaseField):
+    """he field contains a date without a time."""
+
     type: Literal["date"] = "date"
     format: Optional[str] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/datatypes/datetime.py

@@ -9,6 +9,8 @@
 
 
 class DatetimeField(BaseField):
+    """The field contains a date with a time."""
+
     type: Literal["datetime"] = "datetime"
     format: Optional[str] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/datatypes/duration.py

@@ -9,6 +9,8 @@
 
 
 class DurationField(BaseField):
+    """The field contains a duration of time."""
+
     type: Literal["duration"] = "duration"
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/datatypes/geojson.py

@@ -1,14 +1,21 @@
 from __future__ import annotations
 
-from typing import Literal, Optional
+from typing import Literal, Optional, Union
 
 import pydantic
 
 from ..constraints import BaseConstraints
 from .base import BaseField
 
+IGeojsonFormat = Union[
+    Literal["default"],
+    Literal["topojson"],
+]
+
 
 class GeojsonField(BaseField):
+    """The field contains a JSON object according to GeoJSON or TopoJSON spec."""
+
     type: Literal["geojson"] = "geojson"
-    format: Optional[Literal["default"]] = None
+    format: Optional[IGeojsonFormat] = None
     constraints: BaseConstraints = pydantic.Field(default_factory=BaseConstraints)

dplib/models/field/datatypes/geopoint.py

@@ -1,14 +1,22 @@
 from __future__ import annotations
 
-from typing import Literal, Optional
+from typing import Literal, Optional, Union
 
 import pydantic
 
 from ..constraints import BaseConstraints
 from .base import BaseField
 
+IGeojsonFormat = Union[
+    Literal["default"],
+    Literal["array"],
+    Literal["object"],
+]
+
 
 class GeopointField(BaseField):
+    """The field contains data describing a geographic point."""
+
     type: Literal["geopoint"] = "geopoint"
-    format: Optional[Literal["default"]] = None
+    format: Optional[IGeojsonFormat] = None
     constraints: BaseConstraints = pydantic.Field(default_factory=BaseConstraints)

dplib/models/field/datatypes/integer.py

@@ -9,16 +9,18 @@
 
 
 class IntegerField(BaseField):
+    """The field contains integers - that is whole numbers."""
+
     type: Literal["integer"] = "integer"
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)
 
-    bareNumber: Optional[bool] = None
+    groupChar: Optional[str] = None
     """
-    If false leading and trailing non numbers will be removed for integer/number fields
+    String whose value is used to group digits for integer/number fields
     """
 
-    groupChar: Optional[str] = None
+    bareNumber: bool = True
     """
-    String whose value is used to group digits for integer/number fields
+    If false leading and trailing non numbers will be removed for integer/number fields
     """

dplib/models/field/datatypes/list.py

@@ -19,6 +19,10 @@
 
 
 class ListField(BaseField):
+    """The field contains data that is an ordered
+    one-level depth collection of primitive values with a fixed item type.
+    """
+
     type: Literal["list"] = "list"
     format: Optional[Literal["default"]] = None
     constraints: CollectionConstraints = pydantic.Field(

dplib/models/field/datatypes/number.py

@@ -9,21 +9,23 @@
 
 
 class NumberField(BaseField):
+    """The field contains numbers of any kind including decimals."""
+
     type: Literal["number"] = "number"
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)
 
-    bareNumber: Optional[bool] = None
+    decimalChar: str = "."
     """
-    If false leading and trailing non numbers will be removed for integer/number fields
+    String whose value is used to represent a decimal point for number fields
     """
 
     groupChar: Optional[str] = None
     """
     String whose value is used to group digits for integer/number fields
     """
 
-    decimalChar: Optional[str] = None
+    bareNumber: bool = True
     """
-    String whose value is used to represent a decimal point for number fields
+    If false leading and trailing non numbers will be removed for integer/number fields
     """

dplib/models/field/datatypes/object.py

@@ -9,6 +9,8 @@
 
 
 class ObjectField(BaseField):
+    """The field contains a valid JSON object."""
+
     type: Literal["object"] = "object"
     format: Optional[Literal["default"]] = None
     constraints: JsonConstraints = pydantic.Field(default_factory=JsonConstraints)

dplib/models/field/datatypes/string.py

@@ -17,6 +17,8 @@
 
 
 class StringField(BaseField):
+    """The field contains strings, that is, sequences of characters."""
+
     type: Literal["string"] = "string"
     format: Optional[IStringFormat] = None
     constraints: StringConstraints = pydantic.Field(default_factory=StringConstraints)

dplib/models/field/datatypes/time.py

@@ -9,6 +9,8 @@
 
 
 class TimeField(BaseField):
+    """The field contains a time without a date."""
+
     type: Literal["time"] = "time"
     format: Optional[str] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/datatypes/year.py

@@ -9,6 +9,8 @@
 
 
 class YearField(BaseField):
+    """The field contains a calendar year."""
+
     type: Literal["year"] = "year"
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/datatypes/yearmonth.py

@@ -9,6 +9,8 @@
 
 
 class YearmonthField(BaseField):
+    """The field contains a specific month of a specific year."""
+
     type: Literal["yearmonth"] = "yearmonth"
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints = pydantic.Field(default_factory=ValueConstraints)

dplib/models/field/field.py

@@ -9,6 +9,8 @@
 
 
 class Field(BaseField):
+    """Field with unspecified type."""
+
     type: Literal[None] = None
     format: Optional[Literal["default"]] = None
     constraints: BaseConstraints = pydantic.Field(default_factory=BaseConstraints)

dplib/models/schema/__init__.py

@@ -1,2 +1,3 @@
 from .foreignKey import ForeignKey, ForeignKeyReference
 from .schema import Schema
+from .types import IFieldsMatch

pyproject.toml

@@ -90,8 +90,8 @@ dependencies = [
 coverage = [
   "sensible-browser coverage/index.html",
 ]
-build = [
-  "mkdocs build",
+docs = [
+  "mkdocs serve",
 ]
 format = [
   "ruff check --fix",
@@ -110,9 +110,6 @@ release = [
   git push --follow-tags
   """
 ]
-serve = [
-  "mkdocs serve",
-]
 spec = [
   "pytest --cov dplib --cov-report term-missing --cov-report html:coverage --cov-fail-under 0 --timeout=300",
 ]