diff --git a/.github/workflows/capture-core-publish.yml b/.github/workflows/capture-core-publish.yml new file mode 100644 index 00000000..b4ff8d7b --- /dev/null +++ b/.github/workflows/capture-core-publish.yml @@ -0,0 +1,137 @@ +name: Publish agentrust-capture-core to PyPI + +# Tag-scoped to this package, because this repository holds several. A bare +# python-v* pattern would fire this job for an unrelated package's release. +on: + push: + tags: ["capture-core-v*"] + workflow_dispatch: + +permissions: + contents: read + +jobs: + # The tag must agree with the version in pyproject.toml. Otherwise a mistyped + # tag publishes a version nobody asked for, and PyPI will not let you replace + # it: a version number is claimed forever the moment it uploads. + guard: + name: Tag matches the packaged version + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: "3.12" + - name: Compare tag to pyproject version + if: startsWith(github.ref, 'refs/tags/') + run: | + set -euo pipefail + tag="${GITHUB_REF#refs/tags/capture-core-v}" + packaged="$(python -c " + import tomllib, pathlib + print(tomllib.loads(pathlib.Path( + 'packages/agentrust-capture-core/pyproject.toml' + ).read_text())['project']['version']) + ")" + echo "tag=$tag packaged=$packaged" + if [ "$tag" != "$packaged" ]; then + echo "::error::Tag capture-core-v$tag does not match pyproject version $packaged." + exit 1 + fi + + # The vendored copies inside each engine must match what is about to be + # published, or the installed path and the fallback path would ship different + # code under the same version. + consistency: + name: Vendored copies match the package + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: "3.12" + - run: python scripts/sync_vendored_core.py --check + + build: + name: Build distribution + needs: [guard, consistency] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: "3.12" + - run: pip install build twine + - name: Build wheel and sdist + working-directory: packages/agentrust-capture-core + run: python -m build + - name: Verify dist + working-directory: packages/agentrust-capture-core + run: twine check dist/* + # A package whose whole job is fingerprinting should not ship an artifact + # nobody imported. This installs the built wheel into a clean environment, + # asserts nothing third-party came with it, and runs the suite against the + # installed copy rather than the source tree. + - name: Smoke test the built wheel + working-directory: packages/agentrust-capture-core + run: | + set -euo pipefail + python -m venv /tmp/smoke + /tmp/smoke/bin/pip install --quiet dist/*.whl pytest + /tmp/smoke/bin/python - <<'PY' + import agentrust_capture_core as core + import sys + assert callable(core.tree_digest) + assert core.check_seal(core.attach_seal({"a": 1})) == core.INTEGRITY_OK + leaked = [m for m in sys.modules + if m.split(".")[0] in {"pydantic", "cryptography", "requests", "yaml"}] + assert not leaked, "third-party imports leaked into the core: %s" % leaked + print("installed core OK:", core.__version__) + PY + cd tests && /tmp/smoke/bin/python -m pytest . -q + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: dist + path: packages/agentrust-capture-core/dist/ + + publish: + name: Publish to PyPI + needs: build + runs-on: ubuntu-latest + # Trusted Publishing: PyPI verifies this workflow's OIDC identity, so no API + # token exists to leak or rotate. Requires a Trusted Publisher configured on + # PyPI for this repository, workflow filename and environment. + environment: pypi + permissions: + id-token: write + steps: + - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: dist + path: dist/ + - uses: pypa/gh-action-pypi-publish@ba38be9e461d3875417946c167d0b5f3d385a247 # v1.14.1 + + github-release: + name: Create GitHub Release + needs: publish + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: dist + path: dist/ + - uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2 + with: + files: dist/* + generate_release_notes: true diff --git a/packages/agentrust-capture-core/LICENSE b/packages/agentrust-capture-core/LICENSE new file mode 100644 index 00000000..57bc88a1 --- /dev/null +++ b/packages/agentrust-capture-core/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 [yyyy] [name of copyright owner] + + 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. + diff --git a/packages/agentrust-capture-core/pyproject.toml b/packages/agentrust-capture-core/pyproject.toml index b3dfa5e3..18540602 100644 --- a/packages/agentrust-capture-core/pyproject.toml +++ b/packages/agentrust-capture-core/pyproject.toml @@ -7,7 +7,8 @@ name = "agentrust-capture-core" version = "0.1.0" description = "Shared fingerprinting, comparison and baseline-sealing core for AgenTrust agent-integrity capture engines" readme = "README.md" -license = { text = "Apache-2.0" } +license = "Apache-2.0" +license-files = ["LICENSE"] authors = [{ name = "AgenTrust Contributors", email = "oss@agentrust-io.com" }] keywords = ["agent", "integrity", "drift", "attestation", "agent-manifest", "trace"] classifiers = [ @@ -41,5 +42,10 @@ Source = "https://github.com/agentrust-io/integrations/tree/main/packages/agentr [tool.hatch.build.targets.wheel] packages = ["src/agentrust_capture_core"] +# py.typed ships so the "Typing :: Typed" classifier is a true claim rather than a +# decoration: consumers get the annotations this package is written with. +[tool.hatch.build.targets.wheel.force-include] +"src/agentrust_capture_core/py.typed" = "agentrust_capture_core/py.typed" + [tool.ruff] line-length = 100 diff --git a/packages/agentrust-capture-core/src/agentrust_capture_core/py.typed b/packages/agentrust-capture-core/src/agentrust_capture_core/py.typed new file mode 100644 index 00000000..e69de29b