Add vendorization support

.github/workflows/backend-ci.yml

@@ -53,6 +53,8 @@ jobs:
       DJANGO_DANDI_WEB_APP_URL: http://localhost:8085
       DJANGO_DANDI_API_URL: http://localhost:8000
       DJANGO_DANDI_JUPYTERHUB_URL: https://hub.dandiarchive.org/
+      DJANGO_DANDI_INSTANCE_NAME: DANDI
+      DJANGO_DANDI_INSTANCE_IDENTIFIER: "RRID:SCR_017571"
     steps:
       - uses: actions/checkout@v5
         with:

.github/workflows/frontend-ci.yml

@@ -78,6 +78,7 @@ jobs:
       DJANGO_DANDI_WEB_APP_URL: http://localhost:8085
       DJANGO_DANDI_API_URL: http://localhost:8000
       DJANGO_DANDI_JUPYTERHUB_URL: https://hub.dandiarchive.org/
+      DJANGO_DANDI_INSTANCE_NAME: DANDI
 
       # Web client env vars
       VITE_APP_DANDI_API_ROOT: http://localhost:8000/api/

dandiapi/api/management/commands/create_dev_dandiset.py

@@ -2,6 +2,7 @@
 
 from uuid import uuid4
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.core.files.uploadedfile import SimpleUploadedFile
@@ -30,9 +31,12 @@
 def create_dev_dandiset(*, name: str, email: str, num_extra_owners: int):
     owner = User.objects.get(email=email)
 
+    # The licenses field is a set, sort values to ensure consistent behavior
+    licenses = sorted(x.value for x in get_schema_instance_config().licenses)
+
     version_metadata = {
         'description': 'An informative description',
-        'license': ['spdx:CC0-1.0'],
+        'license': licenses[0],
     }
     dandiset, draft_version = create_open_dandiset(
         user=owner, version_name=name, version_metadata=version_metadata

dandiapi/api/models/metadata.py

@@ -1,15 +1,23 @@
 from __future__ import annotations
 
+import importlib
 from typing import TYPE_CHECKING
 from uuid import uuid4
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
+
 if TYPE_CHECKING:
     import datetime
 
+_SCHEMA_INSTANCE_CONFIG = get_schema_instance_config()
+
 
 class PublishableMetadataMixin:
     @classmethod
     def published_by(cls, now: datetime.datetime):
+        instance_name = _SCHEMA_INSTANCE_CONFIG.instance_name
+        instance_identifier = _SCHEMA_INSTANCE_CONFIG.instance_identifier
+
         return {
             'id': uuid4().urn,
             'name': 'DANDI publish',
@@ -20,10 +28,10 @@ def published_by(cls, now: datetime.datetime):
             'wasAssociatedWith': [
                 {
                     'id': uuid4().urn,
-                    'identifier': 'RRID:SCR_017571',
-                    'name': 'DANDI API',
+                    **({'identifier': instance_identifier} if instance_identifier else {}),
+                    'name': f'{instance_name} API',
                     # TODO: version the API
-                    'version': '0.1.0',
+                    'version': importlib.metadata.version('dandiapi'),
                     'schemaKey': 'Software',
                 }
             ],

dandiapi/api/models/version.py

@@ -4,6 +4,7 @@
 import logging
 from typing import TypedDict
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from dandischema.models import AccessType
 from django.conf import settings
 from django.contrib.postgres.indexes import HashIndex
@@ -19,6 +20,8 @@
 
 logger = logging.getLogger(__name__)
 
+_SCHEMA_INSTANCE_CONFIG = get_schema_instance_config()
+
 
 class VersionAssetValidationError(TypedDict):
     field: str
@@ -237,9 +240,11 @@ def _populate_metadata(self):
             ),
             'manifestLocation': manifest_location(self),
             'name': self.name,
-            'identifier': f'DANDI:{self.dandiset.identifier}',
+            'identifier': (f'{_SCHEMA_INSTANCE_CONFIG.instance_name}:{self.dandiset.identifier}'),
             'version': self.version,
-            'id': f'DANDI:{self.dandiset.identifier}/{self.version}',
+            'id': (
+                f'{_SCHEMA_INSTANCE_CONFIG.instance_name}:{self.dandiset.identifier}/{self.version}'
+            ),
             'repository': settings.DANDI_WEB_APP_URL,
             'url': (
                 f'{settings.DANDI_WEB_APP_URL}/dandiset/{self.dandiset.identifier}/{self.version}'

dandiapi/api/services/metadata/__init__.py

@@ -3,6 +3,7 @@
 from typing import TYPE_CHECKING
 
 from celery.utils.log import get_task_logger
+from dandischema.conf import get_instance_config as get_schema_instance_config
 import dandischema.exceptions
 from dandischema.metadata import aggregate_assets_summary, validate
 from django.conf import settings
@@ -116,7 +117,8 @@ def _build_validatable_version_metadata(version: Version) -> dict:
         metadata_for_validation = publishable_version.metadata
 
         metadata_for_validation['id'] = (
-            f'DANDI:{publishable_version.dandiset.identifier}/{publishable_version.version}'
+            f'{get_schema_instance_config().instance_name}:'
+            f'{publishable_version.dandiset.identifier}/{publishable_version.version}'
         )
         metadata_for_validation['url'] = (
             f'{settings.DANDI_WEB_APP_URL}/dandiset/'

dandiapi/api/tests/test_asset.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
+import importlib
 import json
 from uuid import uuid4
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from dandischema.models import AccessType
 from django.conf import settings
 from django.db.utils import IntegrityError
@@ -25,6 +27,8 @@
 
 from .fuzzy import HTTP_URL_RE, TIMESTAMP_RE, URN_RE, UTC_ISO_TIMESTAMP_RE, UUID_RE
 
+_SCHEMA_INSTANCE_CONFIG = get_schema_instance_config()
+
 # Model tests
 
 
@@ -112,6 +116,9 @@ def test_publish_asset(draft_asset: Asset):
     published_asset = draft_asset
     published_asset.refresh_from_db()
 
+    instance_name = _SCHEMA_INSTANCE_CONFIG.instance_name
+    instance_identifier = _SCHEMA_INSTANCE_CONFIG.instance_identifier
+
     assert published_asset.blob == draft_blob
     assert published_asset.full_metadata == {
         **draft_metadata,
@@ -124,10 +131,10 @@ def test_publish_asset(draft_asset: Asset):
             'wasAssociatedWith': [
                 {
                     'id': URN_RE,
-                    'identifier': 'RRID:SCR_017571',
-                    'name': 'DANDI API',
+                    **({'identifier': instance_identifier} if instance_identifier else {}),
+                    'name': f'{instance_name} API',
                     # TODO: version the API
-                    'version': '0.1.0',
+                    'version': importlib.metadata.version('dandiapi'),
                     'schemaKey': 'Software',
                 }
             ],

dandiapi/api/tests/test_info.py

@@ -1,5 +1,9 @@
 from __future__ import annotations
 
+from unittest.mock import ANY
+
+from dandischema.conf import Config
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from django.conf import settings
 
 from dandiapi.api.views.info import get_schema_url
@@ -8,13 +12,18 @@
 
 
 def test_rest_info(api_client):
+    instance_config = get_schema_instance_config()
+
     resp = api_client.get('/api/info/')
     assert resp.status_code == 200
 
     # Get the expected schema URL
     schema_url = get_schema_url()
 
-    assert resp.json() == {
+    resp_json = resp.json()
+
+    assert resp_json == {
+        'instance_config': ANY,
         'schema_version': settings.DANDI_SCHEMA_VERSION,
         'schema_url': schema_url,
         # Matches setuptools_scm's versioning scheme "no-guess-dev"
@@ -27,3 +36,9 @@ def test_rest_info(api_client):
             'jupyterhub': {'url': settings.DANDI_JUPYTERHUB_URL},
         },
     }
+
+    # Verify that the instance config can be reconstituted from the info published by the API
+    reconstituted_instance_config = Config.model_validate(resp_json['instance_config'])
+    assert reconstituted_instance_config == instance_config, (
+        "Instance config can't be reconstituted from API response that publishes it"
+    )

dandiapi/api/tests/test_tasks.py

@@ -2,9 +2,11 @@
 
 import datetime
 import hashlib
+import importlib
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from django.conf import settings
 from django.core.files.storage import default_storage
 from django.forms.models import model_to_dict
@@ -27,6 +29,9 @@
     from rest_framework.test import APIClient
 
 
+_SCHEMA_INSTANCE_CONFIG = get_schema_instance_config()
+
+
 @pytest.mark.django_db
 def test_calculate_checksum_task(asset_blob_factory):
     asset_blob = asset_blob_factory(blob__data=b'known-content', size=13, sha256=None)
@@ -371,6 +376,9 @@ def test_publish_task(
 
     published_version = draft_version.dandiset.versions.latest('created')
 
+    instance_name = _SCHEMA_INSTANCE_CONFIG.instance_name
+    instance_identifier = _SCHEMA_INSTANCE_CONFIG.instance_identifier
+
     assert published_version.metadata == {
         **draft_version.metadata,
         'publishedBy': {
@@ -381,10 +389,10 @@ def test_publish_task(
             'wasAssociatedWith': [
                 {
                     'id': URN_RE,
-                    'identifier': 'RRID:SCR_017571',
-                    'name': 'DANDI API',
+                    **({'identifier': instance_identifier} if instance_identifier else {}),
+                    'name': f'{instance_name} API',
                     # TODO: version the API
-                    'version': '0.1.0',
+                    'version': importlib.metadata.version('dandiapi'),
                     'schemaKey': 'Software',
                 }
             ],
@@ -441,9 +449,9 @@ def test_publish_task(
             'wasAssociatedWith': [
                 {
                     'id': URN_RE,
-                    'identifier': 'RRID:SCR_017571',
-                    'name': 'DANDI API',
-                    'version': '0.1.0',
+                    **({'identifier': instance_identifier} if instance_identifier else {}),
+                    'name': f'{instance_name} API',
+                    'version': importlib.metadata.version('dandiapi'),
                     'schemaKey': 'Software',
                 }
             ],

dandiapi/api/tests/test_version.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
 import datetime
+import importlib
 from time import sleep
 from typing import TYPE_CHECKING
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from dandischema.models import AccessType
 from django.conf import settings
 from freezegun import freeze_time
@@ -27,6 +29,8 @@
 
 from .fuzzy import HTTP_URL_RE, TIMESTAMP_RE, URN_RE, UTC_ISO_TIMESTAMP_RE, VERSION_ID_RE
 
+_SCHEMA_INSTANCE_CONFIG = get_schema_instance_config()
+
 
 @freeze_time()
 @pytest.mark.django_db
@@ -291,6 +295,9 @@ def test_version_publish_version(draft_version, asset):
     publish_version.doi = fake_doi
     publish_version.save()
 
+    instance_name = _SCHEMA_INSTANCE_CONFIG.instance_name
+    instance_identifier = _SCHEMA_INSTANCE_CONFIG.instance_identifier
+
     assert publish_version.dandiset == draft_version.dandiset
     assert publish_version.metadata == {
         **draft_version.metadata,
@@ -302,10 +309,10 @@ def test_version_publish_version(draft_version, asset):
             'wasAssociatedWith': [
                 {
                     'id': URN_RE,
-                    'identifier': 'RRID:SCR_017571',
-                    'name': 'DANDI API',
+                    **({'identifier': instance_identifier} if instance_identifier else {}),
+                    'name': f'{instance_name} API',
                     # TODO: version the API
-                    'version': '0.1.0',
+                    'version': importlib.metadata.version('dandiapi'),
                     'schemaKey': 'Software',
                 }
             ],

dandiapi/api/views/dandiset.py

@@ -4,6 +4,7 @@
 from typing import TYPE_CHECKING
 
 from allauth.socialaccount.models import SocialAccount
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from django.contrib.auth.models import User
 from django.contrib.postgres.lookups import Unaccent
 from django.db import transaction
@@ -425,7 +426,7 @@ def create(self, request: Request):
         identifier = None
         if 'identifier' in serializer.validated_data['metadata']:
             identifier = serializer.validated_data['metadata']['identifier']
-            identifier = identifier.removeprefix('DANDI:')
+            identifier = identifier.removeprefix(f'{get_schema_instance_config().instance_name}:')
 
             try:
                 identifier = int(identifier)

dandiapi/api/views/info.py

@@ -3,13 +3,16 @@
 import importlib.metadata
 from urllib.parse import ParseResult, urlencode, urlparse, urlunparse
 
+from dandischema.conf import get_instance_config as get_schema_instance_config
 from django.conf import settings
 from django.urls import reverse
 from drf_yasg.utils import no_body, swagger_auto_schema
 from rest_framework import serializers
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
 
+_INSTANCE_CONFIG = get_schema_instance_config()
+
 
 def get_schema_url():
     """Get the URL for the schema based on current server deployment."""
@@ -50,6 +53,9 @@ def __init__(self, *args, **kwargs):
             }
         )
 
+    # Instance Configuration
+    instance_config = serializers.JSONField()
+
     # Schema
     schema_version = serializers.CharField()
     schema_url = serializers.URLField()
@@ -71,6 +77,13 @@ def info_view(request):
     api_url = f'{settings.DANDI_API_URL}/api'
     serializer = ApiInfoSerializer(
         data={
+            'instance_config': _INSTANCE_CONFIG.model_dump(
+                # Not excluding any `None` value fields in this object because the `None` values are
+                # needed to reconstitute a `dandischema.conf.Config` instance properly  in any
+                # receiving client since a corresponding environment variable to a field is used to
+                # set the value of the field if the argument for a particular field is not provided.
+                mode='json'
+            ),
             'schema_version': settings.DANDI_SCHEMA_VERSION,
             'schema_url': get_schema_url(),
             'version': importlib.metadata.version('dandiapi'),

dandiapi/settings/base.py

@@ -174,7 +174,6 @@
 DANDI_SCHEMA_VERSION: str = env.str(
     'DJANGO_DANDI_SCHEMA_VERSION', default=_DEFAULT_DANDI_SCHEMA_VERSION
 )
-
 DANDI_ZARR_PREFIX_NAME: str = env.str('DJANGO_DANDI_ZARR_PREFIX_NAME', default='zarr')
 
 # Required environment variables

dev/.env.docker-compose-native

@@ -5,3 +5,4 @@ DJANGO_MINIO_STORAGE_URL=http://minioAccessKey:minioSecretKey@localhost:9000/dan
 DJANGO_DANDI_WEB_APP_URL=http://localhost:8085
 DJANGO_DANDI_API_URL=http://localhost:8000
 DJANGO_DANDI_JUPYTERHUB_URL=https://hub.dandiarchive.org/
+DJANGO_DANDI_INSTANCE_NAME=DANDI