f3-data-models 0.3.0__tar.gz → 0.3.3__tar.gz

{f3_data_models-0.3.0 → f3_data_models-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: f3-data-models
-Version: 0.3.0
+Version: 0.3.3
 Summary: The data schema and models for F3 Nation applications.
 License: MIT
 Author: Evan Petzoldt

{f3_data_models-0.3.0 → f3_data_models-0.3.3}/f3_data_models/models.py

@@ -45,30 +45,59 @@ dt_update = Annotated[
 ]
 
 
-class UserStatus(enum.Enum):
+class User_Status(enum.Enum):
     active = 1
     inactive = 2
     deleted = 3
 
 
-class RegionRole(enum.Enum):
+class Region_Role(enum.Enum):
     user = 1
     editor = 2
     admin = 3
 
 
-class UserRole(enum.Enum):
+class User_Role(enum.Enum):
     user = 1
     editor = 2
     admin = 3
 
 
-class UpdateRequestStatus(enum.Enum):
+class Update_Request_Status(enum.Enum):
     pending = 1
     approved = 2
     rejected = 3
 
 
+class Day_Of_Week(enum.Enum):
+    monday = 0
+    tuesday = 1
+    wednesday = 2
+    thursday = 3
+    friday = 4
+    saturday = 5
+    sunday = 6
+
+
+class Event_Cadence(enum.Enum):
+    Weekly = 1
+    Monthly = 2
+
+
+class Org_Type(enum.Enum):
+    ao = 1
+    region = 2
+    area = 3
+    sector = 4
+    nation = 5
+
+
+class Event_Category(enum.Enum):
+    first_f = 1
+    second_f = 2
+    third_f = 3
+
+
 class Base(DeclarativeBase):
     """
     Base class for all models, providing common methods.
@@ -171,55 +200,13 @@ class SlackSpace(Base):
     updated: Mapped[dt_update]
 
 
-class OrgType(Base):
-    """
-    Model representing an organization type / level. 1=AO, 2=Region, 3=Area, 4=Sector
-
-    Attributes:
-        id (int): Primary Key of the model.
-        name (str): The name of the organization type.
-        description (Optional[text]): A description of the organization type.
-        created (datetime): The timestamp when the record was created.
-        updated (datetime): The timestamp when the record was last updated.
-    """
-
-    __tablename__ = "org_types"
-
-    id: Mapped[intpk]
-    name: Mapped[str]
-    description: Mapped[Optional[text]]
-    created: Mapped[dt_create]
-    updated: Mapped[dt_update]
-
-
-class EventCategory(Base):
-    """
-    Model representing an event category. These are immutable cateogies that we will define at the Nation level.
-
-    Attributes:
-        id (int): Primary Key of the model.
-        name (str): The name of the event category.
-        description (Optional[text]): A description of the event category.
-        created (datetime): The timestamp when the record was created.
-        updated (datetime): The timestamp when the record was last updated.
-    """
-
-    __tablename__ = "event_categories"
-
-    id: Mapped[intpk]
-    name: Mapped[str]
-    description: Mapped[Optional[text]]
-    created: Mapped[dt_create]
-    updated: Mapped[dt_update]
-
-
 class Role(Base):
     """
     Model representing a role. A role is a set of permissions that can be assigned to users.
 
     Attributes:
         id (int): Primary Key of the model.
-        name (RegionRole): The name of the role.
+        name (Region_Role): The name of the role.
         description (Optional[text]): A description of the role.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
@@ -228,7 +215,7 @@ class Role(Base):
     __tablename__ = "roles"
 
     id: Mapped[intpk]
-    name: Mapped[RegionRole]
+    name: Mapped[Region_Role]
     description: Mapped[Optional[text]]
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
@@ -296,7 +283,7 @@ class Org(Base):
     Attributes:
         id (int): Primary Key of the model.
         parent_id (Optional[int]): The ID of the parent organization.
-        org_type_id (int): The ID of the organization type.
+        org_type (Org_Type): The type of the organization.
         default_location_id (Optional[int]): The ID of the default location.
         name (str): The name of the organization.
         description (Optional[text]): A description of the organization.
@@ -324,7 +311,7 @@ class Org(Base):
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
     parent_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
-    org_type_id: Mapped[int] = mapped_column(ForeignKey("org_types.id"))
+    org_type: Mapped[Org_Type]
     default_location_id: Mapped[Optional[int]]
     name: Mapped[str]
     description: Mapped[Optional[text]]
@@ -356,7 +343,9 @@ class Org(Base):
         viewonly=True,
     )
     achievements: Mapped[Optional[List["Achievement"]]] = relationship(
-        "Achievement", secondary="achievements_x_org", cascade="expunge"
+        "Achievement",
+        cascade="expunge",
+        primaryjoin="or_(Achievement.specific_org_id == Org.id, Achievement.specific_org_id.is_(None))",
     )
     parent_org: Mapped[Optional["Org"]] = relationship(
         "Org", remote_side=[id], cascade="expunge"
@@ -375,7 +364,7 @@ class EventType(Base):
         name (str): The name of the event type.
         description (Optional[text]): A description of the event type.
         acronym (Optional[str]): Acronyms associated with the event type.
-        category_id (int): The ID of the associated event category.
+        event_category (Event_Category): The category of the event type (first_f, second_f, third_f).
         specific_org_id (Optional[int]): The ID of the specific organization.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
@@ -387,7 +376,7 @@ class EventType(Base):
     name: Mapped[str]
     description: Mapped[Optional[text]]
     acronym: Mapped[Optional[str]]
-    category_id: Mapped[int] = mapped_column(ForeignKey("event_categories.id"))
+    event_category: Mapped[Event_Category]
     specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
@@ -546,8 +535,12 @@ class Location(Base):
     description: Mapped[Optional[text]]
     is_active: Mapped[bool]
     email: Mapped[Optional[str]]
-    latitude: Mapped[Optional[float]]
-    longitude: Mapped[Optional[float]]
+    latitude: Mapped[Optional[float]] = mapped_column(
+        Float(precision=8, decimal_return_scale=5)
+    )
+    longitude: Mapped[Optional[float]] = mapped_column(
+        Float(precision=8, decimal_return_scale=5)
+    )
     address_street: Mapped[Optional[str]]
     address_street2: Mapped[Optional[str]]
     address_city: Mapped[Optional[str]]
@@ -575,11 +568,11 @@ class Event(Base):
         end_date (Optional[date]): The end date of the event.
         start_time (Optional[time_with_tz]): The start time of the event.
         end_time (Optional[time_with_tz]): The end time of the event.
-        day_of_week (Optional[int]): The day of the week of the event. (0=Monday, 6=Sunday)
+        day_of_week (Optional[Day_Of_Week]): The day of the week of the event.
         name (str): The name of the event.
         description (Optional[text]): A description of the event.
         email (Optional[str]): A contact email address associated with the event.
-        recurrence_pattern (Optional[str]): The recurrence pattern of the event. Current options are 'weekly' or 'monthly'.
+        recurrence_pattern (Optional[Event_Cadence]): The recurrence pattern of the event. Current options are 'weekly' or 'monthly'.
         recurrence_interval (Optional[int]): The recurrence interval of the event (e.g. every 2 weeks).
         index_within_interval (Optional[int]): The index within the recurrence interval. (e.g. 2nd Tuesday of the month).
         pax_count (Optional[int]): The number of participants.
@@ -613,13 +606,13 @@ class Event(Base):
     highlight: Mapped[bool] = mapped_column(Boolean, default=False)
     start_date: Mapped[date]
     end_date: Mapped[Optional[date]]
-    start_time: Mapped[Optional[time_with_tz]]
-    end_time: Mapped[Optional[time_with_tz]]
-    day_of_week: Mapped[Optional[int]]
+    start_time: Mapped[Optional[time_notz]]
+    end_time: Mapped[Optional[time_notz]]
+    day_of_week: Mapped[Optional[Day_Of_Week]]
     name: Mapped[str]
     description: Mapped[Optional[text]]
     email: Mapped[Optional[str]]
-    recurrence_pattern: Mapped[Optional[str]]
+    recurrence_pattern: Mapped[Optional[Event_Cadence]]
     recurrence_interval: Mapped[Optional[int]]
     index_within_interval: Mapped[Optional[int]]
     pax_count: Mapped[Optional[int]]
@@ -733,10 +726,9 @@ class User(Base):
     avatar_url: Mapped[Optional[str]]
     meta: Mapped[Optional[Dict[str, Any]]]
     email_verified: Mapped[Optional[datetime]]
-    status: Mapped[UserStatus] = mapped_column(
-        Enum(UserStatus), default=UserStatus.active
+    status: Mapped[User_Status] = mapped_column(
+        Enum(User_Status), default=User_Status.active
     )
-    role: Mapped[UserRole] = mapped_column(Enum(UserRole), default=UserRole.user)
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -847,6 +839,7 @@ class Achievement(Base):
         description (Optional[str]): A description of the achievement.
         verb (str): The verb associated with the achievement.
         image_url (Optional[str]): The URL of the achievement's image.
+        specific_org_id (Optional[int]): The ID of the specific region if a custom achievement. If null, the achievement is available to all regions.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """
@@ -858,6 +851,7 @@ class Achievement(Base):
     description: Mapped[Optional[str]]
     verb: Mapped[str]
     image_url: Mapped[Optional[str]]
+    specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -883,23 +877,6 @@ class Achievement_x_User(Base):
     )
 
 
-class Achievement_x_Org(Base):
-    """
-    Model representing the association between achievements and organizations.
-
-    Attributes:
-        achievement_id (int): The ID of the associated achievement.
-        org_id (int): The ID of the associated organization.
-    """
-
-    __tablename__ = "achievements_x_org"
-
-    achievement_id: Mapped[int] = mapped_column(
-        ForeignKey("achievements.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-
-
 class Position(Base):
     """
     Model representing a position.
@@ -907,7 +884,7 @@ class Position(Base):
     Attributes:
         name (str): The name of the position.
         description (Optional[str]): A description of the position.
-        org_type_id (Optional[int]): The ID of the associated organization type. This is used to limit the positions available to certain types of organizations. If null, the position is available to all organization types.
+        org_type (Optional[Org_Type]): The associated organization type. This is used to limit the positions available to certain types of organizations. If null, the position is available to all organization types.
         org_id (Optional[int]): The ID of the associated organization. This is used to limit the positions available to certain organizations. If null, the position is available to all organizations.
     """
 
@@ -916,7 +893,7 @@ class Position(Base):
     id: Mapped[intpk]
     name: Mapped[str]
     description: Mapped[Optional[str]]
-    org_type_id: Mapped[Optional[int]] = mapped_column(ForeignKey("org_types.id"))
+    org_type: Mapped[Optional[Org_Type]]
     org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
@@ -1091,7 +1068,7 @@ class UpdateRequest(Base):
         event_end_date (Optional[date]): The end date of the event.
         event_start_time (Optional[time_notz]): The start time of the event.
         event_end_time (Optional[time_notz]): The end time of the event.
-        event_day_of_week (Optional[int]): The day of the week of the event.
+        event_day_of_week (Optional[Day_Of_Week]): The day of the week of the event.
         event_name (str): The name of the event.
         event_description (Optional[text]): A description of the event.
         event_recurrence_pattern (Optional[str]): The recurrence pattern of the event.
@@ -1116,7 +1093,7 @@ class UpdateRequest(Base):
         submitter_validated (Optional[bool]): Whether the submitter has validated the request. Default is False.
         reviewed_by (Optional[str]): The user who reviewed the request.
         reviewed_at (Optional[datetime]): The timestamp when the request was reviewed.
-        status (UpdateRequestStatus): The status of the request. Default is 'pending'.
+        status (Update_Request_Status): The status of the request. Default is 'pending'.
         meta (Optional[Dict[str, Any]]): Additional metadata for the request.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
@@ -1138,7 +1115,7 @@ class UpdateRequest(Base):
     event_end_date: Mapped[Optional[date]]
     event_start_time: Mapped[Optional[time_notz]]
     event_end_time: Mapped[Optional[time_notz]]
-    event_day_of_week: Mapped[Optional[str]] = mapped_column(VARCHAR(length=30))
+    event_day_of_week: Mapped[Optional[Day_Of_Week]]
     event_name: Mapped[str]
     event_description: Mapped[Optional[text]]
     event_recurrence_pattern: Mapped[Optional[str]] = mapped_column(VARCHAR(length=30))
@@ -1170,8 +1147,8 @@ class UpdateRequest(Base):
     submitter_validated: Mapped[Optional[bool]] = mapped_column(Boolean, default=False)
     reviewed_by: Mapped[Optional[text]]
     reviewed_at: Mapped[Optional[datetime]]
-    status: Mapped[UpdateRequestStatus] = mapped_column(
-        Enum(UpdateRequestStatus), default=UpdateRequestStatus.pending
+    status: Mapped[Update_Request_Status] = mapped_column(
+        Enum(Update_Request_Status), default=Update_Request_Status.pending
     )
     meta: Mapped[Optional[Dict[str, Any]]]
 

{f3_data_models-0.3.0 → f3_data_models-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "f3-data-models"
-version = "0.3.0"
+version = "0.3.3"
 description = "The data schema and models for F3 Nation applications."
 authors = ["Evan Petzoldt <evan.petzoldt@protonmail.com>"]
 readme = "README.md"