documentation and converted to username based exclusion of adding new kits

src/submissions/backend/db/models/organizations.py

@@ -3,32 +3,43 @@ from sqlalchemy import Column, String, TIMESTAMP, JSON, Float, INTEGER, ForeignK
 from sqlalchemy.orm import relationship, validates
 
 
+# table containing organization/contact relationship
 orgs_contacts = Table("_orgs_contacts", Base.metadata, Column("org_id", INTEGER, ForeignKey("_organizations.id")), Column("contact_id", INTEGER, ForeignKey("_contacts.id")))
 
 
 class Organization(Base):
-
+    """
+    Base of organization
+    """
     __tablename__ = "_organizations"
 
     id = Column(INTEGER, primary_key=True) #: primary key  
-    name = Column(String(64))
-    submissions = relationship("BasicSubmission", back_populates="submitting_lab")
-    cost_centre = Column(String())
-    contacts = relationship("Contact", back_populates="organization", secondary=orgs_contacts)
-    contact_ids = Column(INTEGER, ForeignKey("_contacts.id", ondelete="SET NULL", name="fk_org_contact_id"))
+    name = Column(String(64)) #: organization name
+    submissions = relationship("BasicSubmission", back_populates="submitting_lab") #: submissions this organization has submitted
+    cost_centre = Column(String()) #: cost centre used by org for payment
+    contacts = relationship("Contact", back_populates="organization", secondary=orgs_contacts) #: contacts involved with this org
+    contact_ids = Column(INTEGER, ForeignKey("_contacts.id", ondelete="SET NULL", name="fk_org_contact_id")) #: contact ids of this organization
 
-    def __str__(self):
+    def __str__(self) -> str:
+        """
+        String representing organization
+
+        Returns:
+            str: string representing organization name
+        """        
         return self.name.replace("_", " ").title()
 
 
 class Contact(Base):
-
+    """
+    Base of Contace
+    """
     __tablename__ = "_contacts"
 
     id = id = Column(INTEGER, primary_key=True) #: primary key  
-    name = Column(String(64))
-    email = Column(String(64))
-    phone = Column(String(32))
-    organization = relationship("Organization", back_populates="contacts", uselist=True)
-    # organization_id = Column(INTEGER, ForeignKey("_organizations.id"))
+    name = Column(String(64)) #: contact name
+    email = Column(String(64)) #: contact email
+    phone = Column(String(32)) #: contact phone number
+    organization = relationship("Organization", back_populates="contacts", uselist=True, secondary=orgs_contacts) #: relationship to joined organization
+    organization_id = Column(INTEGER, ForeignKey("_organizations.id", ondelete="SET NULL", name="fk_contact_org_id")) #: joined organization ids