csa-skilljar 0.8.0__tar.gz

csa_skilljar-0.8.0/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Kurt Seifried kseifried@cloudsecurityalliance.org
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

csa_skilljar-0.8.0/PKG-INFO

@@ -0,0 +1,315 @@
+Metadata-Version: 2.4
+Name: csa-skilljar
+Version: 0.8.0
+Summary: Python client and local MCP server for both Skilljar REST APIs
+Author: Cloud Security Alliance
+Maintainer-email: Kurt Seifried <kseifried@cloudsecurityalliance.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/CloudSecurityAlliance/csa-skilljar
+Project-URL: Issues, https://github.com/CloudSecurityAlliance/csa-skilljar/issues
+Keywords: skilljar,lms,training,mcp,elearning,gainsight
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Requires-Dist: typing_extensions>=4.7
+Requires-Dist: mcp>=2.1
+Provides-Extra: mcp
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: anyio>=4; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: bandit>=1.7; extra == "dev"
+Requires-Dist: pip-audit>=2.7; extra == "dev"
+Dynamic: license-file
+
+```
+project_tracker_base: CINO Project Tracker:appf7fRQUvY9Iy7sL
+project_tracker_table: Projects:tblchmbxSAavvJKaY
+project_tracker_record: csa-skilljar:recbwfx6O30BboQNv
+project_source: github:CloudSecurityAlliance-Internal/CINO-Projects/projects/CloudSecurityAlliance/csa-skilljar
+```
+
+# csa-skilljar
+
+A Python library and local MCP server for the [Skilljar](https://www.skilljar.com/) customer
+education platform, covering **both** of Skilljar's REST APIs — v1 and v2 — behind one set of
+tools.
+
+> **Status: Blocks 1–9 implemented — full 73-tool parity — not yet released.**
+>
+> **76 tools** over Skilljar's v2 API. Install from source until the first PyPI release:
+> `pipx install git+https://github.com/CloudSecurityAlliance/csa-skilljar`
+> | | |
+> |---|---|
+> | **Server** | `check_access` · `describe_capabilities` · `report_a_problem` |
+> | **Courses** | `list_courses` · `get_course` · `create_courses` · `update_courses` |
+> | **Lessons** | `list_lessons` · `get_lesson` · `create_lessons` · `update_lessons` |
+> | **Quizzes** | `list_quizzes` · `get_quiz` · `create_quizzes` · `update_quizzes` · `delete_quizzes` |
+> | **Questions** | `list_questions` · `get_question` · `create_questions` · `update_questions` · `delete_questions` |
+> | **Question banks** | `list_question_banks` · `get_question_bank` · `create_question_banks` · `update_question_banks` · `delete_question_banks` |
+> | **Bank bindings** | `list_quiz_question_bank_assignments` · `bind_quiz_question_banks` · `update_quiz_question_banks` · `unbind_quiz_question_banks` |
+> | **Enrolment** | `list_enrollments` · `get_enrollment` · `update_enrollments` · `complete_enrollments` · `bulk_enroll_students` |
+> | **Reporting** | `list_certificates` · `get_certificate` · `get_course_analytics` · `list_course_ratings` |
+> | **Students** | `list_students` · `get_student` · `create_students` · `update_students` |
+> | **Groups** | `list_groups` · `get_group` · `create_groups` · `update_groups` · `add_group_memberships` · `remove_group_memberships` |
+> | **Signup fields** | `list_signup_field_values` · `get_signup_field_value` · `create_signup_field_values` · `update_signup_field_values` |
+> | **Publishing** | `list_published_courses` · `get_published_course` · `publish_courses` · `update_published_courses` |
+> | **Catalog** | `list_domains` · `get_domain` |
+> | **Course visibility** | `list_visibility_overrides` · `add_visibility_overrides` · `remove_visibility_overrides` |
+> | **Web packages** | `list_web_packages` · `get_web_package` · `create_web_packages` · `update_web_packages` |
+> | **Students (destructive)** | `anonymize_student` · `deactivate_student` · `set_student_password` · `send_password_reset` — gated on `people.destructive`, which no profile but `full` grants |
+> | **Groups (destructive)** | `delete_groups` — a hard delete that cascades to memberships and course visibility; gated on `groups.delete` |
+> | **Publishing (public-facing)** | `unpublish_published_course` · `republish_published_course` · `delete_published_course` — gated on `publishing.write`, which `authoring` does not grant |
+> | **Web packages (destructive)** | `delete_web_package` — refused while a live lesson uses the package |
+> | **Credentials** | `register_oauth_client` — mints an OAuth client; off unless the `admin` profile is named |
+>
+> All 73 official tools are present — asserted by `tests/test_parity.py`, not claimed. The three extra tools are our own server management. See [ROADMAP.md](ROADMAP.md).
+
+## Start with Skilljar's official MCP server
+
+**If you want Skilljar in an AI client, use [Skilljar's own MCP server](https://mcp.skilljar.com/mcp).**
+That is the right default and we recommend it without reservation. It is first-party, hosted and
+maintained by the vendor, needs nothing installed on your machine, covers the whole v2 API in 73
+tools, and authenticates with OAuth and per-operation scopes. Skilljar are actively building v2
+out, so it gets better on their release cadence rather than ours.
+
+```bash
+claude mcp add skilljar --transport http https://mcp.skilljar.com/mcp
+```
+
+Try that first. For most people it is the whole answer.
+
+## …but if you need more
+
+Some things are not in the v2 API yet, so no v2 client can reach them. The v1 API is considerably
+larger — 340 operations against v2's 82 — and today it is the only way to get at:
+
+- **per-lesson learner progress** — v2 reports course-level completion only
+- **webhooks** — v2 has no event notifications at all
+- **asset upload** — v2 has no file upload
+- **learning paths**, **instructor-led training**, and the **commerce stack**
+  (offers, promo codes, purchases, training credits)
+
+`csa-skilljar` exists for that gap. It reproduces the official tool surface exactly — same tool
+names, same argument names — and then adds the v1-only capabilities alongside them, so you do not
+have to choose between the two APIs or run two servers.
+
+It also runs locally over stdio, which some organisations need: your API credentials stay on your
+own machine.
+
+**We expect this project to shrink over time, and that is the intended outcome.** Skilljar has
+publicly reserved OAuth scopes for webhooks, paths, assets, tags and commerce. As those endpoints
+ship, the corresponding v1 support here gets retired in favour of v2 — the tool names stay the
+same and callers notice nothing.
+
+| | Official Skilljar MCP | csa-skilljar |
+|---|---|---|
+| APIs | v2 | v1 + v2 |
+| Transport | remote HTTP | local stdio |
+| Credentials | held server-side | stay on your machine |
+| Auth | OAuth authorization code (browser) | OAuth client credentials + v1 API key |
+| Capability control | OAuth scopes at consent | scopes **plus** per-install profiles |
+| Library | — | the library is the product too |
+
+## Checking the state of Skilljar's v2 API
+
+Skilljar's v2 API is actively growing, and the official MCP server tracks it closely. That is good
+news for everyone — and it means the coverage map in this project has a shelf life. **Before
+assuming a gap documented here is still a gap, re-check upstream.**
+
+```bash
+# 1. The published v2 surface
+curl -s https://api.skilljar.com/v2/openapi.json | jq '.paths | keys | length'
+
+# 2. The declared scope catalogue — a leading indicator of what is coming
+curl -s https://api.skilljar.com/.well-known/oauth-authorization-server \
+  | jq -r '.scopes_supported[]'
+
+# 3. The official MCP server's live tool list
+#    Connect it, then run /mcp in Claude Code.
+```
+
+At the time of writing, the scope catalogue advertises **88 scopes** while the published v2 spec
+uses **28** — areas including webhooks, paths, assets, tags and commerce have scopes reserved but
+no endpoints yet. When those endpoints ship, the v1 fallbacks this project provides for them
+should be retired in favour of v2, and this note updated.
+
+`scripts/check_upstream.py` will automate all three and report drift against the snapshots in
+`specs/`. Until then, run the commands above.
+
+## Credentials
+
+Two independent credentials, both optional. The server starts with either, both, or neither, and
+tells you what is available.
+
+| Variable | For | Obtain from |
+|---|---|---|
+| `CSA_SKILLJAR_V1_API_KEY` | the v1 API | Skilljar Dashboard — see [Skilljar's API guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API) |
+| `CSA_SKILLJAR_V2_CLIENT_ID` / `CSA_SKILLJAR_V2_CLIENT_SECRET` | the v2 API | Skilljar Dashboard, v2 API clients |
+
+We link Skilljar's own documentation rather than transcribing their dashboard navigation, which
+we cannot keep current.
+
+### Connecting it to an MCP client
+
+```bash
+# Recommended: credentials stay in .env, and the client config holds no secret.
+claude mcp add csa-skilljar -- /abs/path/to/csa-skilljar/scripts/mcp-launch.sh
+
+# Or pass them directly - note this writes the literal secret into ~/.claude.json,
+# which is not gitignored, and into your shell history.
+claude mcp add csa-skilljar \
+  -e CSA_SKILLJAR_V2_CLIENT_ID=... -e CSA_SKILLJAR_V2_CLIENT_SECRET=... \
+  -- /abs/path/to/csa-skilljar/.venv/bin/csa-skilljar-mcp
+```
+
+`scripts/mcp-launch.sh` reads `CSA_SKILLJAR_*` variables from the repository's `.env`
+(override with `CSA_SKILLJAR_ENV_FILE`) and execs the server. It parses the file rather
+than sourcing it: `source` executes it, so a stray `echo` would print to stdout and
+corrupt the JSON-RPC stream before the server ever starts.
+
+Use an **absolute path** to the script or to `.venv/bin/csa-skilljar-mcp`. A bare
+`csa-skilljar-mcp` resolves through `PATH`, which may find a different install.
+
+Then call `check_access` first — it is built to work when nothing else does, and reports
+which credentials resolved and which scopes the token carries.
+
+**There is no login step and no browser.** The v2 credential is a machine credential: you create
+an API client in the Skilljar Dashboard, put its id and secret in your MCP client's configuration,
+and the server obtains its own access token on first use (`client_credentials`, ADR-003). No
+redirect URI, no consent screen, no token file on disk. Skilljar's own hosted MCP server does use
+an interactive flow — it is remote and acts for a browser user, which is exactly the constraint
+running locally removes.
+
+Scope the v2 client to what you actually need. The API declares a required scope on every
+operation, and the sensitive ones are separable — `students:anonymize` (irreversible),
+`students:deactivate`, and `students:manage-password` can all be withheld from a client used for
+content authoring.
+
+## What it will cover
+
+Reproduces all 73 official tools, then adds v1-only families in this order:
+
+1. **Learner progress** — per-lesson detail, which v2 does not report
+2. **Assets & media** — v2 has no file upload
+3. **Commerce** — offers, promo codes, purchases, training credits
+4. **Learning paths** — paths, path items, path enrolments
+5. **Events & webhooks** — subscriptions and payload previews
+6. **Instructor-led training** — sessions, instructors, registrations
+7. **Labels & tags**
+
+Deliberately out of scope: catalog page-building, webhook *receiving*, caching, and cross-API
+composite writes. Reasons are in the spec.
+
+## Project documentation
+
+| File | What it answers |
+|---|---|
+| [Design spec](docs/superpowers/specs/2026-08-26-csa-skilljar-design.md) | Architecture, routing rule, credential model, auth error taxonomy, phasing. **Start here.** |
+| [ROADMAP.md](ROADMAP.md) | The block sequence — what ships in what order, and what is parked |
+| [GOALS.md](GOALS.md) | What success looks like and how we would know it failed |
+| [BUSINESS-CASE.md](BUSINESS-CASE.md) | Why CSA is investing, and the honest case that this project should shrink |
+| [TODO.md](TODO.md) | Index of all open work |
+| [DECISIONS-ADR.md](DECISIONS-ADR.md) | Technical decisions and why the rejected alternatives lost |
+| [DECISIONS-PRD.md](DECISIONS-PRD.md) | Scope, audience, and what is deliberately out |
+| [SECURITY-RESOURCES.md](SECURITY-RESOURCES.md) | Exposure surface, prompt-injection risk, credential custody |
+| [DATA-RESOURCES.md](DATA-RESOURCES.md) | What data this handles, and what it deliberately never stores |
+| [WAITING-FOR.md](WAITING-FOR.md) | External conditions we are waiting on, each with an observable trigger |
+| [FRICTION.md](FRICTION.md) | Work that is harder than it should be — including how this project works with AI |
+| [RACI.md](RACI.md) | Who decides what |
+| [CLAUDE.md](CLAUDE.md) | Behavioural contract for AI agents working here |
+
+## Development
+
+**Always use a virtual environment.** The interpreter is pinned by `.python-version`.
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install -e ".[dev]"
+
+.venv/bin/python -m pytest -q          # offline suite: no network, no credentials
+.venv/bin/ruff check src tests scripts
+.venv/bin/mypy
+
+./scripts/verify.sh                    # or just this: everything CI checks
+```
+
+Commands are written `.venv/bin/...` deliberately — a bare `pytest` resolves to whatever
+is on `PATH`, which is how a suite passes against the wrong dependency versions.
+
+Contributions follow [CSA's public repo standards](https://github.com/CloudSecurityAlliance-Internal/CINO-Platform-Engineering/blob/main/PUBLIC-GITHUB-REPO-STANDARDS.md):
+branch and PR for every change, required CI gates, no direct pushes to `main`.
+
+## Releasing
+
+Publishing uses **PyPI Trusted Publishing** — GitHub Actions authenticates over OIDC and
+proves its identity with the repository, workflow and environment it is running in.
+**There is no API token anywhere**: not in the repository, not in a GitHub secret, not in
+a `.pypirc`. Nothing to leak, rotate, or accidentally commit.
+
+The identity PyPI checks is exactly this:
+
+| Field | Value |
+|---|---|
+| PyPI project | `csa-skilljar` |
+| Owner | `CloudSecurityAlliance` |
+| Repository | `csa-skilljar` |
+| Workflow | `release.yml` |
+| Environment | `pypi` |
+
+**One-time setup** (a person with the PyPI account, per `RACI.md` — credential and
+publishing identity are not delegated): at
+<https://pypi.org/manage/account/publishing/>, add a **pending publisher** with the five
+values above. "Pending" is the form used when the project does not exist on PyPI yet; it
+becomes a normal trusted publisher on first upload.
+
+**Each release:**
+
+```bash
+# 1. Bump the single source of truth and refresh the editable install.
+#    src/csa_skilljar/__init__.py  __version__ = "X.Y.Z"
+.venv/bin/python -m pip install -e ".[dev]"
+./scripts/verify.sh
+
+# 2. Merge, then tag from main. The tag MUST equal the packaged version - the
+#    workflow refuses to publish when they disagree, rather than shipping a
+#    mislabelled artifact.
+git tag vX.Y.Z && git push origin vX.Y.Z
+gh release create vX.Y.Z --notes-from-tag
+```
+
+Publishing the GitHub release starts `release.yml`, which reruns the tests, `pip-audit`
+and `bandit`, checks the tag against the packaged version, builds, and refuses to upload
+an artifact containing anything matching `.env`, `token`, `secret`, `credential`,
+`analysis/` or `docs-html/`, or missing `py.typed`.
+
+It then waits: the `pypi` environment has a **required reviewer**, so the upload does not
+happen until a human approves it in the Actions run. Worth knowing that GitHub creates a
+missing environment *unprotected* on first use — so `environment: pypi` in a workflow is
+a claim, not a control, until the environment actually exists with rules on it.
+
+## Licence
+
+[Apache-2.0](LICENSE).
+
+## Acknowledgements
+
+Skilljar is a Gainsight product. This project is not affiliated with or endorsed by Skilljar or
+Gainsight; it is an independent client built against their public APIs. The API snapshots in
+`specs/` are fetched from Skilljar's published, publicly accessible OpenAPI documents.