aixand-lib-github-source 0.1.0b0__py3-none-any.whl

aixand_lib_github_source-0.1.0b0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: aixand-lib-github-source
+Version: 0.1.0b0
+Summary: Standalone public GitHub source snapshots and commit comparison
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# GitHub Source
+
+Standalone Python 3.11+ acquisition of public GitHub repository content. Install
+`aixand-lib-github-source`, import `github_source`. Runtime dependencies: none. No Git,
+curl, background worker, or service is required.
+
+```python
+from github_source import Client
+
+client = Client(timeout=30, retries=2)
+source = client.resolve(
+    "https://github.com/example/repository",
+    ref="main", path="skills/review",
+)
+snapshot = client.fetch(source)
+
+latest = client.resolve(source["url"], ref=source["ref"], path=source["path"])
+relationship = client.compare(source, latest)["relationship"]
+```
+
+Repository, `tree`, and `blob` URLs are supported. Slash-containing branch names
+are resolved against GitHub. When overriding the reference in a directory/file
+URL, supply an explicit `path` if it cannot be derived unambiguously.
+
+## Contracts
+
+`resolve` returns a `github-source/source-1` mapping with stable repository ID,
+canonical repository name/URL, requested reference, selected path, exact commit,
+reference kind (`branch`, `tag`, or `commit`), and the root Git tree identity when
+provided by GitHub. Reference kind is descriptive; callers decide pinning/tracking.
+
+`fetch` returns `github-source/snapshot-1` containing the resolved source, a
+`github-source/tree-1` tree, and its SHA-256 content digest. Paths remain relative
+to the repository root, including for scoped selections. Trees preserve original
+file bytes as `content_b64`, executable flags, and directories (including empty
+directories). A file selection returns that file only; the library has no special
+knowledge of SKILL.md, pack.json, or server.json. Callers select a containing
+directory when their package needs accompanying files.
+
+Content identity hashes sorted canonical UTF-8 JSON with finite values. Directories
+are normalized and sorted, including implicit parents. Commit/origin metadata is
+outside the tree digest, so unrelated repository commits can have equal content
+identities. Hashes establish equality and integrity, not publisher authenticity.
+
+`compare` accepts two selections from the same repository identity/path and returns
+their commits and GitHub's `ahead`, `identical`, `behind`, or `diverged` relationship.
+It does not decide whether to activate, merge, install, or overwrite content.
+
+The exported `ResolvedSource`, `SourceTree`, `FileEntry`, `Snapshot`, and
+`Comparison` TypedDicts describe these JSON contracts. `GitHubError` exposes a
+stable `code`, optional HTTP `status` and integer `retry_after`, and `to_dict()`.
+Codes include `validation`, `integrity`, `size`, `not_found`, `unsupported`,
+`network`, `rate_limited`, `access_denied`, `conflict`, and `cancelled`.
+
+## Bounds and transport
+
+Downloads use HTTPS with restricted redirect hosts. A selected directory is fetched
+through Git trees and commit-pinned raw files; each file is checked against its
+Git blob identity. Repository downloads use GitHub archives without a checkout.
+No downloaded scripts or hooks execute, and the library does not write files.
+
+Limits: 64 MiB per repository archive, 128 MiB total source bytes, 16 MiB per file,
+10,000 entries including implicit directories, 32 path components, 1,024 path
+characters, and 255 UTF-8 bytes per component. Tree/metadata response sizes are
+bounded separately. Archive expansion, including tar metadata, is bounded before
+unbounded allocation. Symlinks, hard links, submodules, special files, unsafe or
+colliding portable paths, and unresolved Git LFS pointers are rejected. A repository
+archive containing submodule declarations requires a narrower supported selection.
+
+`Client(timeout=30, retries=2, cancelled=None, progress=None)` has a 0–60 second
+positive socket timeout and at most three retries. Transient network/server failures
+use bounded backoff. Rate limits are reported for the caller to reschedule; the
+library does not wait for a rate-limit reset. No credentials or private repositories
+are supported in this version.
+
+`cancelled()` returns a boolean. Cancellation is checked between requests, read
+chunks, backoff steps, tree entries, and archive entries; a blocked socket remains
+bounded by its timeout. `progress(event)` receives download byte progress. Scoped
+downloads use up to four threads, so callbacks must be thread-safe. Callback
+exceptions propagate. Snapshots are captured in memory within the limits above.
+
+## Ownership
+
+This library owns URL/reference resolution, snapshot acquisition, and commit
+comparison. Native format discovery, accepted storage, customization/reconciliation,
+tracking schedules, persistent jobs, and dependency installation belong to callers.
+The `aixand-libraries/` location is a repository organization choice, not a runtime path
+dependency. Applications supply their own adapters and storage policies.
+
+## Development
+
+```sh
+python -m pip install -e .
+python -m unittest discover -s tests -v
+python -m pip wheel --no-deps .
+```
+
+Tests use local fixtures and mocked transport, including an isolated copied-package
+check with site packages disabled. They require no GitHub credentials or network.
+
+## Local developer commands
+
+Inside the aixand-libraries source checkout, run from this directory with
+Python 3.11+ and uv:
+
+```sh
+./dev.sh develop --local
+./dev.sh check
+./dev.sh test
+./dev.sh build
+```
+
+Use `.\dev.ps1` on Windows. Each package owns its development environment and
+helper. Commands run within this package. See the
+[development guide](docs/development.md) for wheel-based setup without sibling
+sources, lock updates, and build outputs.
+
+## Documentation and support
+
+See the [documentation index](docs/README.md) for usage, API reference, and runnable
+starter examples. Report ordinary problems through the integrating product's
+support channel or issue tracker. External contributions are not currently
+accepted due to limited maintainer capacity; see [reporting guidance](../docs/reporting.md).
+Report vulnerabilities [privately](../SECURITY.md).

aixand_lib_github_source-0.1.0b0.dist-info/RECORD

@@ -0,0 +1,13 @@
+aixand_lib_github_source-0.1.0b0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+github_source/__init__.py,sha256=GWWZGNqX-dkfsFkTj6s61GVtaGjK4pllwlZXRF6EkSk,391
+github_source/client.py,sha256=t73vNASnNlRRd4PX0OWvgtmmNdcKCB5_VF1gGuw--Ko,20897
+github_source/contracts.py,sha256=4a4MgC8b2rSKh126dgCqHIllJpiFqFQxT9ElPxlVmho,6373
+github_source/errors.py,sha256=e3_Nkde5SEySXRQNdo_FNx_3rLWeQ4NosGU2ndAurHI,595
+github_source/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+github_source/snapshots.py,sha256=9qK0Ifzgjm9-x7kMuaC_a5Y6d3LQfxJ5CKtJf91UZk4,4144
+github_source/types.py,sha256=yWgWCqvPMNRyhmtYOx3eTtmvdxcKR570yX6AAoSQkEg,816
+github_source/urls.py,sha256=0JeuGLyHbHVYPCni_WLYXp6gbwp9FoX2R5nykXMcSxQ,2200
+aixand_lib_github_source-0.1.0b0.dist-info/METADATA,sha256=c4v-UGAXjvCmliqt4rz0h87BN3dMcLQbM4xTr5POQ4M,6237
+aixand_lib_github_source-0.1.0b0.dist-info/WHEEL,sha256=16fc_9Rp854SLcdhaDEjr0u65p0e3FhZxihNgcnCE98,91
+aixand_lib_github_source-0.1.0b0.dist-info/top_level.txt,sha256=mwO4ShfvwRQdSLwiFmEmP0FF7synmAXFehyX5bi1NtE,14
+aixand_lib_github_source-0.1.0b0.dist-info/RECORD,,

aixand_lib_github_source-0.1.0b0.dist-info/WHEEL

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

aixand_lib_github_source-0.1.0b0.dist-info/licenses/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.

aixand_lib_github_source-0.1.0b0.dist-info/top_level.txt

@@ -0,0 +1 @@
+github_source

github_source/__init__.py

@@ -0,0 +1,17 @@
+"""Standalone public GitHub source acquisition. No Git dependency."""
+
+from .client import Client
+from .errors import GitHubError
+from .types import Comparison, FileEntry, ResolvedSource, Snapshot, SourceTree
+
+__version__ = "0.1.0b0"
+__all__ = [
+    "Client",
+    "GitHubError",
+    "Comparison",
+    "FileEntry",
+    "ResolvedSource",
+    "Snapshot",
+    "SourceTree",
+    "__version__",
+]