Skip to main content

A module for DOI registration

Project description

OARepo DOI

OARepo DOI adds community-specific DOI configuration to OARepo/InvenioRDM installations. It provides a DOI settings service and administration views, and extends the DataCite PID provider so DOI registration can use credentials configured for the record's default community.

Features

  • Stores DataCite credentials per community.
  • Resolves DOI credentials from a record's default community.
  • Falls back to the standard global DataCite configuration when no community-specific settings exist.
  • Registers DOI settings in the Invenio administration interface.
  • Keeps DataCite passwords encrypted in the database.

Installation

The package is intended to be installed as part of an OARepo 14 based application.

pip install oarepo-doi

DOI Settings

Each DOI settings record connects a community to DataCite credentials:

  • community_slug: slug of the community using these DOI credentials
  • prefix: DataCite DOI prefix
  • username: DataCite username
  • password: DataCite password, stored encrypted

Only one DOI settings record can exist for a given community slug.

The service is registered under the community-doi service id and uses the doi-settings search alias.

REST API

The DOI settings resource is exposed under:

/doi_settings
/doi_settings/<id>

The resource supports reading, updating and deleting DOI settings records. Search, create, update and delete operations are protected by the DOI settings permission policy and are available to system processes and administration users.

Example payload:

{
  "community_slug": "example-community",
  "prefix": "10.12345",
  "username": "datacite-user",
  "password": "datacite-password"
}

When a DOI settings record is created or updated, the referenced community must exist. If the community slug cannot be found, the service returns a bad request.

DataCite Integration

The package provides two record-aware DataCite classes:

  • oarepo_doi.services.providers.client:DataCiteRecordAwareClient
  • oarepo_doi.services.providers.provider:DataCiteRecordAwareProvider

The provider binds the current record to the DataCite client before DOI generation, registration, update, restore and delete operations. The client then looks up DOI settings for the record's default community.

When community DOI settings are found, DOI generation uses the community prefix and the DataCite API client is created from the community username, password and prefix. When no community DOI settings are found, the implementation falls back to the standard InvenioRDM DataCite client and global DATACITE_* configuration.

Configuration

The DataCite client also respects the standard global DataCite configuration when no community settings are available, including:

DATACITE_PREFIX = "10.12345"
DATACITE_USERNAME = "user"
DATACITE_PASSWORD = "password"
DATACITE_FORMAT = "{prefix}/{id}"
DATACITE_TEST_MODE = True

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oarepo_doi-4.0.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oarepo_doi-4.0.0-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file oarepo_doi-4.0.0.tar.gz.

File metadata

  • Download URL: oarepo_doi-4.0.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oarepo_doi-4.0.0.tar.gz
Algorithm Hash digest
SHA256 83d2a98a1a9b6eb98b5cc80738524ba2402a2821f1f254ea193c6c5e3537612f
MD5 0c9c86e1cf89200efb60924c077f44c3
BLAKE2b-256 7c1f8d0fb680df3d8af92e5f0ed71d168711ff561071e01586e6d773b3e54151

See more details on using hashes here.

File details

Details for the file oarepo_doi-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: oarepo_doi-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 37.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oarepo_doi-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2396bbc0df6e2afde8b7b56f0b813eb5ec9e25443a901995b3610427f70652c
MD5 7cf4ceaa0f8cefbca18c55176bfaffc8
BLAKE2b-256 9a60872a6ac29986049047125c4178cd5cf243927c006f6027cc673b7914828d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page