Skip to content

Introducing Dandiset DOIs #2350

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 1 commit into
base: master
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
73 changes: 67 additions & 6 deletions dandiapi/api/doi.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# All of the required DOI configuration settings
DANDI_DOI_SETTINGS = [
(settings.DANDI_DOI_API_URL, 'DANDI_DOI_API_URL'),
(settings.DANDI_DOI_API_URL, 'DANDI_DOI_API_USER'),
(settings.DANDI_DOI_API_USER, 'DANDI_DOI_API_USER'),
(settings.DANDI_DOI_API_PASSWORD, 'DANDI_DOI_API_PASSWORD'),
(settings.DANDI_DOI_API_PREFIX, 'DANDI_DOI_API_PREFIX'),
]
Expand All @@ -24,22 +24,81 @@ def doi_configured() -> bool:
return any(setting is not None for setting, _ in DANDI_DOI_SETTINGS)


def _generate_doi_data(version: Version):
# TODO(asmacdo) findable dois
# def _generate_doi_data(version: Version, event: str):
def _generate_doi_data(version: Version, version_doi=True):
from dandischema.datacite import to_datacite

publish = settings.DANDI_DOI_PUBLISH
# Use the DANDI test datacite instance as a placeholder if PREFIX isn't set
prefix = settings.DANDI_DOI_API_PREFIX or '10.80507'
dandiset_id = version.dandiset.identifier
version_id = version.version
doi = f'{prefix}/dandi.{dandiset_id}/{version_id}'
if version_doi:
doi = f'{prefix}/dandi.{dandiset_id}/{version_id}'
else:
doi = f'{prefix}/dandi.{dandiset_id}'
metadata = version.metadata
metadata['doi'] = doi
return (doi, to_datacite(metadata, publish=publish))
# TODO(asmacdo) findable dois
# datacite_body = to_datacite(metadata, event=event)
datacite_body = to_datacite(metadata, version_doi=version_doi)
return (doi, datacite_body)

def update_dandiset_doi(version: Version) -> str:
Copy link
Member Author

@asmacdo asmacdo Apr 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this whole chunk is unnecessary? #1709 (comment)

If we can just point to the Dandiset DOI to the DLP, rather than the latest version then we dont need to update. But we dont choose the url in dandi-archive, so this would require a change in dandi-schema

payload = {
"data": {
"attributes": {
"url": version.metadata["url"]
}
}
}
if doi_configured():
logger.info(f"updating {version.dandiset} DOI {version.dandiset.doi} pointer to {version.metadata['url']}!")
try:
requests.put(
f"{settings.DANDI_DOI_API_URL}/{version.dandiset.doi}",
json=payload,
auth=requests.auth.HTTPBasicAuth(
settings.DANDI_DOI_API_USER,
settings.DANDI_DOI_API_PASSWORD,
),
timeout=30,
).raise_for_status()
except requests.exceptions.HTTPError as e:
logger.exception('Failed to update Dandiset DOI %s', version.dandiset.doi)
logger.exception(payload)
if e.response:
logger.exception(e.response.text)
raise
else:
logger.debug("Skipping Datacite API usage, doi is not configured.")


def create_dandiset_doi(version: Version) -> str:
doi, request_body = _generate_doi_data(version, version_doi=False)
if doi_configured():
try:
requests.post(
settings.DANDI_DOI_API_URL,
json=request_body,
auth=requests.auth.HTTPBasicAuth(
settings.DANDI_DOI_API_USER,
settings.DANDI_DOI_API_PASSWORD,
),
timeout=30,
).raise_for_status()
except requests.exceptions.HTTPError as e:
logger.exception('Failed to create DOI %s', doi)
logger.exception(request_body)
if e.response:
logger.exception(e.response.text)
raise
return doi


def create_doi(version: Version) -> str:
doi, request_body = _generate_doi_data(version)
def create_version_doi(version: Version) -> str:
doi, request_body = _generate_doi_data(version, version_doi=True)
# If DOI isn't configured, skip the API call
if doi_configured():
try:
Expand All @@ -58,6 +117,8 @@ def create_doi(version: Version) -> str:
if e.response:
logger.exception(e.response.text)
raise
else:
print("DOI NOT CONFIGURED!!!")
return doi


Expand Down
1 change: 1 addition & 0 deletions dandiapi/api/models/dandiset.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class EmbargoStatus(models.TextChoices):
starred_users = models.ManyToManyField(
to=User, through='DandisetStar', related_name='starred_dandisets'
)
doi = models.CharField(max_length=64, null=True, default=None, blank=True) # noqa: DJ001

class Meta:
ordering = ['id']
Expand Down
10 changes: 10 additions & 0 deletions dandiapi/api/services/dandiset/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from django.db import transaction

from dandiapi.api import doi
from dandiapi.api.models.dandiset import Dandiset, DandisetStar
from dandiapi.api.models.version import Version
from dandiapi.api.services import audit
Expand Down Expand Up @@ -55,6 +56,15 @@ def create_dandiset(
audit.create_dandiset(
dandiset=dandiset, user=user, metadata=draft_version.metadata, embargoed=embargo
)
def _create_dandiset_doi(version_id: int):
version = Version.objects.get(id=version_id)
version.doi = doi.create_dandiset_doi(version)
version.save()
version.dandiset.doi = version.doi
version.dandiset.save()


transaction.on_commit(lambda: _create_dandiset_doi(draft_version.id))

return dandiset, draft_version

Expand Down
9 changes: 6 additions & 3 deletions dandiapi/api/services/publish/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,15 @@ def _publish_dandiset(dandiset_id: int, user_id: int) -> None:
# published version has been committed to DB.
transaction.on_commit(lambda: write_manifest_files.delay(new_version.id))

def _create_doi(version_id: int):
def _create_version_doi(version_id: int):
# Create Version DOI
version = Version.objects.get(id=version_id)
version.doi = doi.create_doi(version)
version.doi = doi.create_version_doi(version)
version.save()
# PUT to Dandiset DOI, should reference this version now
doi.update_dandiset_doi(version)

transaction.on_commit(lambda: _create_doi(new_version.id))
transaction.on_commit(lambda: _create_version_doi(new_version.id))

user = User.objects.get(id=user_id)
audit.publish_dandiset(
Expand Down
Loading