orcid

git.splent.io/splent-io/splent_feature_orcid

v0.5.2 full Refines profile

About

Sign in and sign up with ORCID, connect an ORCID iD to an account from its profile, and tell other features which iDs are linked here (OrcidService)

Refinement

Refines
Extends models
UserProfile with UserProfileOrcidMixin

It changes profile in place, without a fork, so the product installs both.

Provides

Services
OrcidService
Routes
/account/connect/orcid/orcid/authorize/orcid/login
Hooks filled
auth.login.providerslayout.head.cssprofile.edit.sectionssignup.providers
Translations
es

Configuration

Setting Default What it does
ORCID_CLIENT_ID empty The application registered at https://orcid.org/developer-tools (or at https://sandbox.orcid.org/developer-tools for the sandbox). Without both values ORCID sign-in is off: the app logs a warning at start, and whoever tries is told it is not available.
ORCID_CLIENT_SECRET empty No description yet.
ORCID_BASE_URL https://orcid.org The ORCID the application is registered with. https://sandbox.orcid.org for development and tests, whose iDs and credentials only exist there.
ORCID_SCOPE /authenticate What the sign-in asks ORCID for. /authenticate gives the iD and the name, which is all a sign-in needs; a product that reads or writes records on ORCID asks for more, and registers the application for it.

These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.

Dependencies

Works better with

In product lines

  • openhubs_spl In a group One or more of the identities group, when a product takes that group Needs auth identities profile

Extension points

Templates
hooks/orcid_login_button.htmlhooks/orcid_profile_row.html
Services
OrcidService
Routes
A refinement can add routes to its blueprint

Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.

Compatibility

Python
>=3.13
SPLENT framework
>=1.30.0