splent_feature_github

The github feature of a SPLENT product line.

Sign in and sign up with GitHub, and connect a GitHub account to an account from its profile. A new account takes the email GitHub shares, or else the verified primary address of the GitHub account, and the name it gives. A GitHub account always signs in to the account it is linked to, and never to an existing account because the 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, GitHub 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 10 in the first three, before ORCID's 20. The button carries where the reader was heading (?next=), and only a path on this site. The disconnect button opens identities' modal.

GitHub's dark grey is in assets/css/github.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-github and the github-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. GitHub follows the rule identities holds for every provider.

Translations

The edit-profile row ships with a Spanish catalog.

Use it in a product

splent feature:add splent_feature_github

Develop

splent feature:test splent_feature_github
splent feature:contract splent_feature_github

Release

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

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.