clstaudt
commented
1 year ago @vlad-ed-git
The model classes should contain all the necessary information, including a field description. How can the UI code reuse them?
class Contract(SQLModel, table=True):
"""A contract defines the business conditions of a project"""
id: Optional[int] = Field(default=None, primary_key=True)
title: str = Field(description="Short description of the contract.")
client: Client = Relationship(
back_populates="contracts", sa_relationship_kwargs={"lazy": "subquery"}
)
signature_date: datetime.date = Field(
description="Date on which the contract was signed",
)
start_date: datetime.date = Field(
description="Date from which the contract is valid",
)
end_date: Optional[datetime.date] = Field(
description="Date until which the contract is valid",
)
# Contract n:1 Client
client_id: Optional[int] = Field(
default=None,
foreign_key="client.id",
)
rate: condecimal(decimal_places=2) = Field(
description="Rate of remuneration",
)
is_completed: bool = Field(
default=False, description="flag marking if contract has been completed"
)
currency: str # TODO: currency representation
VAT_rate: Decimal = Field(
description="VAT rate applied to the contractual rate.",
default=0.19, # TODO: configure by country?
)
unit: TimeUnit = Field(
description="Unit of time tracked. The rate applies to this unit.",
sa_column=sqlalchemy.Column(sqlalchemy.Enum(TimeUnit)),
default=TimeUnit.hour,
)
units_per_workday: int = Field(
description="How many units of time (e.g. hours) constitute a whole work day?",
default=8,
)
volume: Optional[int] = Field(
description="Number of units agreed on",
)
term_of_payment: Optional[int] = Field(
description="How many days after receipt of invoice this invoice is due.",
default=31,
)
billing_cycle: Cycle = Field(
sa_column=sqlalchemy.Column(sqlalchemy.Enum(Cycle)),
description="How often is an invoice sent?",
)
``
vlad-ed-git
flamesjames
Forms should more clearly describe which input is accepted and validate it.