splent-feature-github 0.1.0__py3-none-any.whl

splent_feature_github-0.1.0.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: splent_feature_github
+Version: 0.1.0
+License-Expression: LGPL-3.0-or-later
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: COPYING
+License-File: COPYING.LESSER
+Dynamic: license-file
+
+# splent_feature_github
+
+The `github` feature of a [SPLENT](https://splent.io) 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
+
+| Setting | Default | What it is |
+|---|---|---|
+| `GITHUB_CLIENT_ID` | empty | The client id of the OAuth app registered at https://github.com/settings/developers |
+| `GITHUB_CLIENT_SECRET` | empty | Its secret |
+
+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.
+
+| Slot | Opened by | What GitHub draws |
+|---|---|---|
+| `auth.login.providers` | auth | The GitHub button, under "or continue with" |
+| `signup.providers` | signup, when the product has it | The same button, after the sign-up form |
+| `profile.edit.sections` | profile | The linked account with a disconnect button, or a "Connect GitHub" link |
+| `layout.head.css` | the product's app shell | Its stylesheet, `assets/css/github.css` |
+
+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.
+
+| Visitor | With signup | Without signup |
+|---|---|---|
+| Signs in with a GitHub account already linked | Signed in | Signed in |
+| Connects GitHub from their profile | Linked | Linked |
+| Signs in with a GitHub account linked to nobody | A new account is opened | Sent back to the login page with a translated message that asks them to request access from an administrator, or to connect GitHub from their profile if they have an account |
+
+## Translations
+
+The edit-profile row ships with a Spanish catalog.
+
+## Use it in a product
+
+```bash
+splent feature:add splent_feature_github
+```
+
+## Develop
+
+```bash
+splent feature:test splent_feature_github
+splent feature:contract splent_feature_github
+```
+
+## Release
+
+```bash
+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.

splent_feature_github-0.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+splent_feature_github-0.1.0.dist-info/licenses/COPYING,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+splent_feature_github-0.1.0.dist-info/licenses/COPYING.LESSER,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+splent_io/splent_feature_github/__init__.py,sha256=0RGjnjOWq-clO2kQRBwgEh2W4UUvzCeJzbPGRKWDUrw,1043
+splent_io/splent_feature_github/config.py,sha256=jvMhRCliD6Agt267xYAUOvh4S63mmJGRiglw9Bj_5fo,463
+splent_io/splent_feature_github/hooks.py,sha256=6j9gknDwMmx0y3n2VTb7tPb4lWQBuHRfDCXAtM_3Nb0,2184
+splent_io/splent_feature_github/models.py,sha256=8a4VtZS9A0_IYTUABSBt7Cy9E9ZnAQOrIU3nzbbfubo,998
+splent_io/splent_feature_github/repositories.py,sha256=vHqRbXWUyK8MO4O7AGDjnzaC_5Nrf_E36w3zVWSGFpY,367
+splent_io/splent_feature_github/routes.py,sha256=VEiOgYvvvglb0fbIk84SBU7ZMx7UsQNCAN6lVjACTS8,4035
+splent_io/splent_feature_github/services.py,sha256=YGNA4kOqlKf_ANXsJs9xxEFIRV0YiWXUoyPQ4QsY1-U,12506
+splent_io/splent_feature_github/signals.py,sha256=GDdwKZ22_mt5K7y9-qmBMj1MI9fHtB-GgM2fW_aFeqo,591
+splent_io/splent_feature_github/assets/css/github.css,sha256=f2EBGgG1I0Lem0DikND_SSkJ3aM4pJFkY3BxWM0QiUc,1969
+splent_io/splent_feature_github/migrations/alembic.ini,sha256=WA1biGHSZpXO-M7uFtAZVRSV5Fih0VIQY-Yp7G7xGTk,517
+splent_io/splent_feature_github/migrations/env.py,sha256=2JeB8GO8qfNikGJL-VH-__hrC5T9aa_KoBDFIBkN17M,315
+splent_io/splent_feature_github/migrations/script.py.mako,sha256=8_xgA-gm_OhehnO7CiIijWgnm00ZlszEHtIHrAYFJl0,494
+splent_io/splent_feature_github/migrations/versions/7ace6050fb3f_splent_feature_github.py,sha256=u2zqW9gzPM44iXq8anUTWzKGAPfY1Prr7zSkvOaUDHI,1147
+splent_io/splent_feature_github/templates/hooks/github_login_button.html,sha256=M_XZrdiJeNMCG9_xXjr-bPW81NfUJfOvsw-7SN7J8e4,335
+splent_io/splent_feature_github/templates/hooks/github_profile_row.html,sha256=WR-YtrYCptl-nJzVev-lsuMjEW_7x1JH8oVVP3LREtM,3350
+splent_io/splent_feature_github/translations/es/LC_MESSAGES/messages.mo,sha256=KF1a_E0TSpx3auPu7R2JjVSclrSWTY9bVg38yeuYCCs,531
+splent_io/splent_feature_github/translations/es/LC_MESSAGES/messages.po,sha256=LwswsEuVa7bGLLCG98FeadNfj3Bh5OnGACsY-NHnldc,905
+splent_feature_github-0.1.0.dist-info/METADATA,sha256=bId2_M-DRMKdkQUl1uPTiK3t4jrv5SDcOcsf-xPaR3Y,3780
+splent_feature_github-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+splent_feature_github-0.1.0.dist-info/top_level.txt,sha256=nksrfdr_edPhGPUsCqz08kyNRLBkNc2sInZYzmbZ4TA,10
+splent_feature_github-0.1.0.dist-info/RECORD,,

splent_feature_github-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+