Update docs

Author: mbsantiago

back/pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
   "alembic>=1.13.2",
   "bcrypt==4.0.1",
   "colorama>=0.4.6",
+  "setuptools>=75.1.0",
 ]
 requires-python = ">=3.11"
 readme = "README.md"

back/src/whombat/api/features.py

@@ -163,7 +163,7 @@ def to_soundevent(
             The soundevent feature object.
         """
         return data.Feature(
-            name=feature.name,
+            term=data.term_from_key(feature.name),
             value=feature.value,
         )
 

back/src/whombat/api/notes.py

@@ -134,6 +134,7 @@ def to_soundevent(
                 email=user.email,
                 username=user.username,
                 name=user.name,
+                institution=None,
             )
 
         return data.Note(

back/src/whombat/api/tags.py

@@ -133,7 +133,7 @@ def to_soundevent(
             The soundevent tag object.
         """
         return data.Tag(
-            key=tag.key,
+            term=data.term_from_key(tag.key),
             value=tag.value,
         )
 

back/src/whombat/api/users.py

@@ -257,6 +257,7 @@ def to_soundevent(
             username=obj.username,
             email=obj.email,
             name=obj.name,
+            institution=None,
         )
 
     def _get_pk_condition(self, pk: UUID):

back/src/whombat/routes/dependencies/users.py

@@ -15,7 +15,7 @@
 
 
 async def get_user_db(session: Session) -> AsyncGenerator[UserDatabase, None]:
-    """Get the user database.""" ""
+    """Get the user database."""
     yield UserDatabase(session, models.User)
 
 

back/tests/conftest.py

@@ -1,4 +1,5 @@
-"""Common fixtures for Whombat tests.""" ""
+"""Common fixtures for Whombat tests."""
+
 import logging
 import os
 import random

back/tests/test_api/test_datasets.py

@@ -29,7 +29,7 @@ async def test_dataset_is_stored_with_relative_audio_dir(
     session: AsyncSession,
     audio_dir: Path,
 ):
-    """Test that a dataset is stored with a relative audio dir.""" ""
+    """Test that a dataset is stored with a relative audio dir."""
     dataset_audio_dir = audio_dir / "dataset_audio_dir"
     dataset_audio_dir.mkdir()
     dataset = await api.datasets.create(