f3-data-models 0.5.10__tar.gz → 0.5.12__tar.gz

{f3_data_models-0.5.10 → f3_data_models-0.5.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: f3-data-models
-Version: 0.5.10
+Version: 0.5.12
 Summary: The data schema and models for F3 Nation applications.
 License: MIT
 Author: Evan Petzoldt
@@ -81,3 +81,34 @@ poetry run python -m http.server --directory _build/html
 
 > [!TIP]  
 > Adding new fields as nullable (ie `Optional[]`) has the best chance of reducing breaking changes to the apps.
+
+# Entity Overview
+
+```mermaid
+---
+config:
+    look: handDrawn
+    theme: dark
+---
+
+erDiagram
+    USERS ||--|{ ATTENDANCE : have
+    ATTENDANCE }|--|| EVENT_INSTANCES: at
+    ATTENDANCE }|..|{ ATTENDANCE_TYPES : "are of type(s)"
+    EVENT_INSTANCES }|..|| EVENTS : "part of series"
+    EVENT_INSTANCES }|..|{ EVENT_TYPES : "with type(s)"
+    EVENTS }|..|{ EVENT_TYPES : "with type(s)"
+    EVENT_INSTANCES }|--|| ORGS : "belong to"
+    EVENT_INSTANCES }|..|| LOCATIONS : "at"
+    EVENTS }|--|| ORGS : "belong to"
+    EVENTS }|..|| LOCATIONS : "at"
+    SLACK_SPACES ||..|| ORGS : "are connected to"
+    USERS ||..|{ SLACK_USERS : "have one or more"
+    SLACK_USERS }|--|| SLACK_SPACES : "belong to"
+    USERS }|..|{ ACHIEVEMENTS : "earn"
+    USERS }|..|{ ROLES : "have"
+    ROLES ||..|{ PERMISSIONS : "have"
+    ROLES }|..|{ ORGS : "in"
+    USERS }|..|{ POSITIONS : "hold"
+    POSITIONS }|..|{ ORGS : "in"
+```

{f3_data_models-0.5.10 → f3_data_models-0.5.12}/README.md

@@ -50,4 +50,35 @@ poetry run python -m http.server --directory _build/html
 ```
 
 > [!TIP]  
-> Adding new fields as nullable (ie `Optional[]`) has the best chance of reducing breaking changes to the apps.
+> Adding new fields as nullable (ie `Optional[]`) has the best chance of reducing breaking changes to the apps.
+
+# Entity Overview
+
+```mermaid
+---
+config:
+    look: handDrawn
+    theme: dark
+---
+
+erDiagram
+    USERS ||--|{ ATTENDANCE : have
+    ATTENDANCE }|--|| EVENT_INSTANCES: at
+    ATTENDANCE }|..|{ ATTENDANCE_TYPES : "are of type(s)"
+    EVENT_INSTANCES }|..|| EVENTS : "part of series"
+    EVENT_INSTANCES }|..|{ EVENT_TYPES : "with type(s)"
+    EVENTS }|..|{ EVENT_TYPES : "with type(s)"
+    EVENT_INSTANCES }|--|| ORGS : "belong to"
+    EVENT_INSTANCES }|..|| LOCATIONS : "at"
+    EVENTS }|--|| ORGS : "belong to"
+    EVENTS }|..|| LOCATIONS : "at"
+    SLACK_SPACES ||..|| ORGS : "are connected to"
+    USERS ||..|{ SLACK_USERS : "have one or more"
+    SLACK_USERS }|--|| SLACK_SPACES : "belong to"
+    USERS }|..|{ ACHIEVEMENTS : "earn"
+    USERS }|..|{ ROLES : "have"
+    ROLES ||..|{ PERMISSIONS : "have"
+    ROLES }|..|{ ORGS : "in"
+    USERS }|..|{ POSITIONS : "hold"
+    POSITIONS }|..|{ ORGS : "in"
+```

{f3_data_models-0.5.10 → f3_data_models-0.5.12}/f3_data_models/models.py

@@ -399,6 +399,7 @@ class Org(Base):
         instagram (Optional[str]): The organization's Instagram handle.
         last_annual_review (Optional[date]): The date of the last annual review.
         meta (Optional[Dict[str, Any]]): Additional metadata for the organization.
+        ao_count (int): The number of AOs associated with the organization. Defaults to 0, will be updated by triggers.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
 
@@ -427,6 +428,7 @@ class Org(Base):
     instagram: Mapped[Optional[str]]
     last_annual_review: Mapped[Optional[date]]
     meta: Mapped[Optional[Dict[str, Any]]]
+    ao_count: Mapped[Optional[int]] = mapped_column(Integer, default=0, nullable=True)
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -471,6 +473,7 @@ class EventType(Base):
         acronym (Optional[str]): Acronyms associated with the event type.
         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.
+        is_active (bool): Whether the event type is active. Default is True.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """  # noqa: E501
@@ -483,6 +486,7 @@ class EventType(Base):
     acronym: Mapped[Optional[str]]
     event_category: Mapped[Event_Category]
     specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
+    is_active: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False)
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -987,7 +991,7 @@ class Attendance(Base):
 
         event_instance (EventInstance): The associated event instance.
         user (User): The associated user.
-        slack_user (Optional[SlackUser]): The associated Slack user.
+        slack_users (Optional[List[SlackUser]]): The associated Slack Users for this User (a User can be in multiple SlackSpaces).
         attendance_x_attendance_types (List[Attendance_x_AttendanceType]): The association between the attendance and attendance types.
         attendance_types (List[AttendanceType]): The associated attendance types.
     """  # noqa: E501
@@ -1010,7 +1014,7 @@ class Attendance(Base):
 
     event_instance: Mapped[EventInstance] = relationship(innerjoin=True, cascade="expunge", viewonly=True)
     user: Mapped[User] = relationship(innerjoin=True, cascade="expunge", viewonly=True)
-    slack_user: Mapped[Optional[SlackUser]] = relationship(
+    slack_users: Mapped[Optional[List[SlackUser]]] = relationship(
         innerjoin=False, cascade="expunge", secondary="users", viewonly=True
     )
     attendance_x_attendance_types: Mapped[List[Attendance_x_AttendanceType]] = relationship(

{f3_data_models-0.5.10 → f3_data_models-0.5.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "f3-data-models"
-version = "0.5.10"
+version = "0.5.12"
 description = "The data schema and models for F3 Nation applications."
 authors = ["Evan Petzoldt <evan.petzoldt@protonmail.com>"]
 readme = "README.md"
@@ -10,6 +10,9 @@ license = "MIT"
 repository = "https://github.com/F3-Nation/f3-data-models"
 documentation = "https://github.io/F3-Nation/f3-data-models"
 
+[tool.poetry.group.dev.dependencies]
+poethepoet = "^0.34.0"
+
 [tool.ruff]
 line-length = 120
 
@@ -50,6 +53,10 @@ sqlmodel = "^0.0.22"
 alembic-postgresql-enum = "^1.6.1"
 sqlalchemy-citext = "^1.8.0"
 
+[tool.poe.tasks]
+install-js = "npm install"
+build-js = "npm run build"
+install-mermaid-js = "npm install --save-dev @mermaid-js/mermaid-cli"
 
 [build-system]
 requires = ["poetry-core"]