Merge pull request #6 from OpenDataServices/short-license-titles

Add short titles for licenses

Author: tillywoodfield

oc4ids_datastore_api/models.py

@@ -10,7 +10,8 @@ class DatasetSQLModel(SQLModel, table=True):
     source_url: str
     publisher_name: str
     license_url: str | None
-    license_name: str | None
+    license_title: str | None
+    license_title_short: str | None
     json_url: str | None
     csv_url: str | None
     xlsx_url: str | None

oc4ids_datastore_api/schemas.py

@@ -9,7 +9,8 @@ class Publisher(BaseModel):
 
 class License(BaseModel):
     url: str | None
-    name: str | None
+    title: str | None
+    title_short: str | None
 
 
 class Download(BaseModel):

oc4ids_datastore_api/services.py

@@ -16,7 +16,11 @@ def _transform_dataset(dataset: DatasetSQLModel) -> Dataset:
         loaded_at=dataset.updated_at,
         source_url=dataset.source_url,
         publisher=Publisher(name=dataset.publisher_name),
-        license=License(url=dataset.license_url, name=dataset.license_name),
+        license=License(
+            url=dataset.license_url,
+            title=dataset.license_title,
+            title_short=dataset.license_title_short,
+        ),
         downloads=downloads,
     )
 

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "oc4ids-datastore-api"
 description = "OC4IDS Datastore API"
-version = "0.1.0"
+version = "0.2.0"
 readme = "README.md"
 dependencies = [
   "fastapi[standard]",

tests/test_services.py

@@ -17,7 +17,8 @@ def test_get_all_datasets(mocker: MockerFixture) -> None:
         source_url="https://test-dataset.json",
         publisher_name="test_publisher",
         license_url="https://license.com",
-        license_name="License",
+        license_title="License",
+        license_title_short="L",
         json_url="https://downloads/test_dataset.json",
         csv_url="https://downloads/test_dataset.csv",
         xlsx_url="https://downloads/test_dataset.xlsx",
@@ -31,7 +32,7 @@ def test_get_all_datasets(mocker: MockerFixture) -> None:
         loaded_at=now,
         source_url="https://test-dataset.json",
         publisher=Publisher(name="test_publisher"),
-        license=License(name="License", url="https://license.com"),
+        license=License(title="License", title_short="L", url="https://license.com"),
         downloads=[
             Download(format="json", url="https://downloads/test_dataset.json"),
             Download(format="csv", url="https://downloads/test_dataset.csv"),
@@ -51,7 +52,8 @@ def test_get_all_datasets_missing_download_formats(mocker: MockerFixture) -> Non
         source_url="https://test-dataset.json",
         publisher_name="test_publisher",
         license_url="https://license.com",
-        license_name="License",
+        license_title="License",
+        license_title_short="L",
         json_url="https://downloads/test_dataset.json",
         csv_url=None,
         xlsx_url=None,
@@ -65,7 +67,7 @@ def test_get_all_datasets_missing_download_formats(mocker: MockerFixture) -> Non
         loaded_at=now,
         source_url="https://test-dataset.json",
         publisher=Publisher(name="test_publisher"),
-        license=License(name="License", url="https://license.com"),
+        license=License(title="License", title_short="L", url="https://license.com"),
         downloads=[
             Download(format="json", url="https://downloads/test_dataset.json"),
         ],