Generate project abbreviation code for project name

epictrack-api/migrations/versions/88b0bbb53b72_unique_abbreviation.py

@@ -0,0 +1,30 @@
+"""Add unique constraint to projects abbreviation
+
+Revision ID: 88b0bbb53b72
+Revises: 03791c319e2b
+Create Date: 2023-12-05 11:34:09.723702
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '88b0bbb53b72'
+down_revision = '03791c319e2b'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('projects', schema=None) as batch_op:
+        batch_op.create_unique_constraint('uq_projects_abbreviation', ['abbreviation'])
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('projects', schema=None) as batch_op:
+        batch_op.drop_constraint('uq_projects_abbreviation', type_='unique')
+    # ### end Alembic commands ###

epictrack-api/src/api/models/project.py

@@ -63,7 +63,7 @@ class Project(BaseModelVersioned):
     proponent_id = Column(ForeignKey("proponents.id"), nullable=False)
     region_id_env = Column(ForeignKey("regions.id"), nullable=True)
     region_id_flnro = Column(ForeignKey("regions.id"), nullable=True)
-    abbreviation = Column(String(10), nullable=True)
+    abbreviation = Column(String(10), nullable=True, unique=True)
     sub_type = relationship("SubType", foreign_keys=[sub_type_id], lazy="select")
     type = relationship("Type", foreign_keys=[type_id], lazy="select")
     proponent = relationship("Proponent", foreign_keys=[proponent_id], lazy="select")
@@ -82,6 +82,11 @@ def check_existence(cls, name, project_id=None):
             return True
         return False
 
+    @classmethod
+    def get_by_abbreviation(cls, abbreviation: str):
+        """Get project by abbreviation."""
+        return Project.query.filter_by(abbreviation=abbreviation).first()
+
     def as_dict(self, recursive=True):
         """Return JSON Representation."""
         data = super().as_dict(recursive)