Skip to content

Feat: initial clearinghouse models #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pems/clearinghouse/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from django.contrib import admin

from pems.clearinghouse import models


admin.site.register(models.DataCatalog)
admin.site.register(models.CatalogEntry)
38 changes: 38 additions & 0 deletions pems/clearinghouse/migrations/0001_initial.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Generated by Django 5.2.3 on 2025-07-17 04:55

from django.db import migrations, models


class Migration(migrations.Migration):

initial = True

dependencies = []

operations = [
migrations.CreateModel(
name="DataCatalog",
fields=[
("id", models.AutoField(primary_key=True, serialize=False)),
("name", models.TextField(help_text="The name of this data catalog.")),
("slug", models.SlugField(help_text="The unique slug for this data catalog.", unique=True)),
],
options={
"verbose_name": "Data Catalog",
"verbose_name_plural": "Data Catalogs",
},
),
migrations.CreateModel(
name="CatalogEntry",
fields=[
("id", models.AutoField(primary_key=True, serialize=False)),
("name", models.TextField(help_text="The name of this catalog entry.")),
("slug", models.SlugField(help_text="The unique slug for this catalog entry.", unique=True)),
("catalogs", models.ManyToManyField(to="clearinghouse.datacatalog")),
],
options={
"verbose_name": "Catalog Entry",
"verbose_name_plural": "Catalog Entries",
},
),
]
Empty file.
32 changes: 32 additions & 0 deletions pems/clearinghouse/models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
from django.db import models


class DataCatalog(models.Model):
"""Defines a data catalog in the Clearinghouse."""

class Meta:
verbose_name = "Data Catalog"
verbose_name_plural = "Data Catalogs"

id = models.AutoField(primary_key=True)
name = models.TextField(help_text="The name of this data catalog.")
slug = models.SlugField(help_text="The unique slug for this data catalog.", unique=True)

def __str__(self):
return self.name


class CatalogEntry(models.Model):
"""Defines an entry in a data catalog."""

class Meta:
verbose_name = "Catalog Entry"
verbose_name_plural = "Catalog Entries"

id = models.AutoField(primary_key=True)
catalogs = models.ManyToManyField(DataCatalog)
name = models.TextField(help_text="The name of this catalog entry.")
slug = models.SlugField(help_text="The unique slug for this catalog entry.", unique=True)

def __str__(self):
return self.name
26 changes: 26 additions & 0 deletions tests/pytest/pems/clearinghouse/test_models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import pytest

from pems.clearinghouse import models


@pytest.fixture
def data_catalog():
return models.DataCatalog.objects.create(name="Data Catalog", slug="data-catalog")


@pytest.fixture
def catalog_entry(data_catalog):
data_catalog.catalogentry_set.create(name="Catalog Entry", slug="catalog-entry")
return data_catalog.catalogentry_set.first()


@pytest.mark.django_db
class TestDataCatalog:
def test_str(self, data_catalog):
assert str(data_catalog) == "Data Catalog"


@pytest.mark.django_db
class TestCatalogEntry:
def test_str(self, catalog_entry):
assert str(catalog_entry) == "Catalog Entry"
Loading