splent_feature_orcid

The orcid feature of a SPLENT product line.

Sign in and sign up with ORCID, and connect an ORCID iD to an account from its profile. A new account asks for an email address first, since ORCID rarely shares one, and is filled with the name ORCID gives. An ORCID iD always signs in to the account it is linked to, and never to an existing account because the typed email matches. It needs auth, profile and identities, which keeps the linked accounts and the shared OAuth registry.

A SPLENT feature is a Python package that a product composes with others. Its models, routes, services, templates and hooks are registered when the product starts. What this feature provides and requires is listed in the [tool.splent.contract] section of pyproject.toml, which splent feature:contract --write keeps in sync with the source.

Settings

Without both, ORCID sign-in fails with a message and the app logs a warning at startup.

Where it shows

It fills the slots other features open, by name, so it composes with whatever the product has and overrides nothing.

It takes order 20 in the first three, after GitHub's 10. The button carries where the reader was heading (?next=), and only a path on this site.

ORCID's green is in assets/css/orcid.css, never on the elements. The public shell loads the file from the asset registry (register_asset), and the app shell, which does not render the registry, through layout.head.css. A product that wants another look overrides .btn.btn-orcid and the orcid-identity__* classes in a stylesheet of its own.

A product without signup

A product that does not install splent_feature_signup is closed, and its accounts are opened by an administrator. ORCID follows the rule identities holds for every provider.

Without signup the ORCID button goes straight to ORCID, since the email step only serves a new account.

What it adds to the profile

{"name": "Ada", "surname": "Lovelace", "email": "ada@example.com", "orcid": "0000-0002-1825-0097"}

Without academic_profile the affiliation is not kept and the account is created all the same.

get_orcid() is a method and adds no column. It sits beside the other refiners of UserProfile, such as academic_profile, which adds affiliation to the same model, so a product can have both.

register_profile_payload and profile_columns are new in the profile released with this version. Against an older profile ORCID still starts. It reads the columns from the UserProfile table instead, and leaves the orcid key out with a warning in the log. An older profile's edit page also opens no profile.edit.sections slot, so it shows no ORCID row, and the iD cannot be connected or disconnected from the profile. Signing in with ORCID works as usual. Only a missing module or function counts as an older profile. An error inside profile's own code stops the start as it is, rather than passing for one.

Translations

The edit-profile row ships with a Spanish catalog.

Use it in a product

splent feature:add splent_feature_orcid

Develop

splent feature:test splent_feature_orcid
splent feature:contract splent_feature_orcid

Release

splent feature:release splent_feature_orcid --dry-run --bump patch
splent feature:release splent_feature_orcid

The first command rehearses the release and changes nothing. The second publishes it to the git forge and to PyPI, and a PyPI version is permanent.