oras-pants-plugin 0.1.0__py3-none-any.whl

oras_pants_plugin/fields.py

@@ -0,0 +1,113 @@
+"""The fields the plugin adds to `pex_binary` and `pex_binaries` targets."""
+
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
+
+from pants.backend.python.target_types import PexBinariesGeneratorTarget, PexBinary
+from pants.engine.addresses import Address
+from pants.engine.target import BoolField, Field, InvalidFieldException, StringField, StringSequenceField
+from pants.util.strutil import softwrap
+
+if TYPE_CHECKING:
+    from pants_plugin_developer_utils import CollectedRules
+
+
+def is_untagged_reference(reference: str) -> bool:
+    """
+    Whether `reference` is a `<registry>/<repository>` OCI reference without a `:<tag>` or `@<digest>` suffix.
+
+    A registry host may carry a port (`localhost:5000/app`), so only the last path segment is inspected.
+    """
+    registry, separator, repository = reference.rpartition("/")
+    return bool(registry and separator and repository) and ":" not in repository and "@" not in repository
+
+
+class OrasRepositoriesField(StringSequenceField):
+    """Where `oras` pushes the target's package output, as untagged OCI references."""
+
+    alias = "oci_repositories"
+    help = softwrap(
+        """
+        The OCI repositories to push this target's package output to as an OCI artifact, given as
+        `<registry>/<repository>` references such as `ghcr.io/my-org/my-app` or `localhost:5000/my-app`.
+        `pants publish` runs one `oras push` per entry, tagging the artifact with every `oci_tags` entry, so a
+        reference MUST NOT carry a `:<tag>` or `@<digest>` suffix. Leave unset to skip the target.
+        """
+    )
+
+    @classmethod
+    def compute_value(cls, raw_value: Iterable[str] | None, address: Address) -> tuple[str, ...] | None:
+        value = super().compute_value(raw_value, address)
+        invalid = [reference for reference in value or () if not is_untagged_reference(reference)]
+        if invalid:
+            raise InvalidFieldException(
+                softwrap(
+                    f"""
+                    The `{cls.alias}` field in target {address} must contain `<registry>/<repository>` references
+                    without a tag or digest; the tags come from the `{OrasTagsField.alias}` field.
+                    Invalid entries: {invalid}.
+                    """
+                )
+            )
+        return value
+
+
+class OrasTagsField(StringSequenceField):
+    """The tags `oras` applies to the pushed artifact in every repository."""
+
+    alias = "oci_tags"
+    default = ("latest",)
+    help = softwrap(
+        """
+        The tags to apply to the pushed OCI artifact in every `oci_repositories` entry. An empty list pushes the
+        artifact untagged, addressable by its digest only.
+        """
+    )
+
+
+class OciMediaType(StringField):
+    """What OCI `artifactType` to designate the `oras`-published artifact."""
+
+    alias = "oci_media_type"
+    help = softwrap(
+        """
+        The media type identifying the kind of OCI artifact that wraps the package output of this target, passed
+        to `oras push` as `--artifact-type` and stored as the manifest's `artifactType`.
+        See also: https://oras.land/docs/concepts/artifact
+        """
+    )
+
+
+class PexOciMediaType(OciMediaType):
+    """The default OCI artifact type for a PEX published via `oras` to an OCI registry."""
+
+    default = "application/vnd.python.pex.v1"
+
+
+class SkipOrasPublishField(BoolField):
+    """A custom field to opt-out of `oras` publication to the configured OCI registry(s)."""
+
+    alias = "skip_oras"
+    default = False
+    help = "If true, don't publish this target's package output with `oras` during `pants publish`."
+
+
+PEX_BINARY_PLUGIN_FIELDS: tuple[type[Field], ...] = (
+    OrasRepositoriesField,
+    OrasTagsField,
+    PexOciMediaType,
+    SkipOrasPublishField,
+)
+"""The fields registered on `pex_binary`, and moved from `pex_binaries` onto the targets it generates."""
+
+
+def rules() -> CollectedRules:
+    """Registers the plugin's fields on `pex_binary` and `pex_binaries`."""
+    return (
+        *(PexBinary.register_plugin_field(field) for field in PEX_BINARY_PLUGIN_FIELDS),
+        # `pex_binaries` moves its per-binary fields onto the generated `pex_binary` targets; so must these.
+        *(
+            PexBinariesGeneratorTarget.register_plugin_field(field, as_moved_field=True)
+            for field in PEX_BINARY_PLUGIN_FIELDS
+        ),
+    )

oras_pants_plugin/goals/publish.py

@@ -0,0 +1,203 @@
+"""
+Implements a publisher for wrapping `BuiltPackage` instances as OCI artifacts and publishing those to an OCI
+registry by using `oras`.
+See also:
+    https://www.pantsbuild.org/stable/docs/writing-plugins/common-plugin-tasks/add-a-publisher
+    https://oras.land/
+"""
+
+import os
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Final
+
+from pants.backend.python.goals.package_pex_binary import PexBinaryFieldSet
+from pants.backend.python.target_types import PexLayoutField
+from pants.core.goals.package import PackageFieldSet
+from pants.core.goals.publish import (
+    CheckSkipRequest,
+    CheckSkipResult,
+    PublishFieldSet,
+    PublishOutputData,
+    PublishPackages,
+    PublishProcesses,
+    PublishRequest,
+)
+from pants.core.util_rules.env_vars import environment_vars_subset
+from pants.core.util_rules.external_tool import download_external_tool
+from pants.engine.env_vars import EnvironmentVarsRequest
+from pants.engine.fs import Digest, MergeDigests
+from pants.engine.intrinsics import merge_digests
+from pants.engine.platform import Platform
+from pants.engine.process import InteractiveProcess, Process, ProcessCacheScope
+from pants.engine.rules import collect_rules, concurrently, implicitly, rule
+from pants.engine.unions import UnionRule
+from pants.util.logging import LogLevel
+from pants.util.strutil import pluralize
+
+from oras_pants_plugin.fields import (
+    OciMediaType,
+    OrasRepositoriesField,
+    OrasTagsField,
+    PexOciMediaType,
+    SkipOrasPublishField,
+)
+from oras_pants_plugin.subsystem import ORAS_BASE_ENV_VAR_NAMES, Oras
+
+if TYPE_CHECKING:
+    from pants_plugin_developer_utils import CollectedRules
+
+ORAS_INPUT_DIR: Final[str] = "__oras__"
+"""Sandbox directory the downloaded `oras` binary is mounted in, out of the way of the pushed files."""
+
+
+class OrasPublishRequest(PublishRequest["OrasPublishFieldSet"]):
+    """The general `PublishRequest` type which should be subtyped per `oras`-publishable target type."""
+
+
+class OrasPublishPexRequest(OrasPublishRequest):
+    """The `PublishRequest` subtype specifically for publishing PEX artifacts to OCI registries."""
+
+
+@dataclass(frozen=True)
+class OrasPublishFieldSet(PublishFieldSet[OrasPublishRequest]):
+    """
+    The base `PublishFieldSet` to subtype per `oras`-publishable target type.
+
+    A subtype narrows `required_fields` to the target type's `OciMediaType` subclass, so `oci_media_type` carries
+    that subclass's default.
+    """
+
+    required_fields = (OrasRepositoriesField, OrasTagsField, OciMediaType, SkipOrasPublishField)
+
+    oci_repositories: OrasRepositoriesField
+    oci_tags: OrasTagsField
+    oci_media_type: OciMediaType
+    skip_oras: SkipOrasPublishField
+
+    def check_skip_request(self, package_fs: PackageFieldSet) -> OrasPublishSkipRequest | None:
+        return OrasPublishSkipRequest(package_fs=package_fs, publish_fs=self)
+
+    def get_output_data(self) -> PublishOutputData:
+        return PublishOutputData({"publisher": "oras", **super().get_output_data()})
+
+
+@dataclass(frozen=True)
+class OrasPublishPexFieldSet(OrasPublishFieldSet):
+    """The fields required for publishing a `pex_binary` target's package output artifact to an OCI registry."""
+
+    publish_request_type = OrasPublishPexRequest
+    required_fields = (*OrasPublishFieldSet.required_fields, PexOciMediaType, PexLayoutField)
+
+
+class OrasPublishSkipRequest(CheckSkipRequest[OrasPublishFieldSet]):
+    """The input to determining if an `oras`-compatible target should be skipped during a publish run."""
+
+
+@rule(desc="Checks whether `oras push` is skipped for a target.", level=LogLevel.DEBUG)
+async def check_if_skip_oras_push(request: OrasPublishSkipRequest, oras: Oras) -> CheckSkipResult:
+    """Skips both packaging and publishing when nothing would be pushed, and says why."""
+    if oras.skip:
+        reason = f"(by `[{Oras.options_scope}].skip = True`)"
+    elif request.publish_fs.skip_oras.value:
+        reason = f"(by `{request.publish_fs.skip_oras.alias}` on {request.address})"
+    elif not request.publish_fs.oci_repositories.value:
+        reason = f"(no `{request.publish_fs.oci_repositories.alias}` specified for {request.address})"
+    else:
+        return CheckSkipResult.no_skip()
+    name = (
+        request.package_fs.output_pex_filename()
+        if isinstance(request.package_fs, PexBinaryFieldSet)
+        else request.address.spec
+    )
+    return CheckSkipResult.skip(names=[name], description=reason, data=request.publish_fs.get_output_data())
+
+
+@dataclass(frozen=True)
+class OrasPushRequest:
+    """One `oras push`: every `files` entry becomes a layer of the artifact at `repository`, tagged with `tags`."""
+
+    repository: str
+    tags: tuple[str, ...]
+    files: tuple[str, ...]
+    input_digest: Digest
+    artifact_type: str | None = None
+
+    @property
+    def reference(self) -> str:
+        """The `<repository>[:<tag>[,<tag>...]]` argument of `oras push`; no tags pushes the artifact untagged."""
+        return f"{self.repository}:{','.join(self.tags)}" if self.tags else self.repository
+
+
+def construct_oras_push_argv(oras: Oras, exe: str, request: OrasPushRequest) -> tuple[str, ...]:
+    """Returns the full `oras push` command line for `request`, with `[oras].args` after the plugin's own flags."""
+    argv: list[str] = [exe, "push"]
+    if request.artifact_type:
+        argv.extend(["--artifact-type", request.artifact_type])
+    argv.extend(oras.args)
+    argv.append(request.reference)
+    # `oras` parses `<file>:<media type>`, so a path containing `:` needs a trailing `:` to keep the default type.
+    argv.extend(f"{file}:" if ":" in file else file for file in request.files)
+    return tuple(argv)
+
+
+@rule(desc="Set up an `oras push` process", level=LogLevel.DEBUG)
+async def setup_oras_push_process(request: OrasPushRequest, oras: Oras, platform: Platform) -> Process:
+    downloaded_oras, env = await concurrently(
+        download_external_tool(oras.get_request(platform)),
+        environment_vars_subset(
+            EnvironmentVarsRequest([*ORAS_BASE_ENV_VAR_NAMES, *oras.extra_env_vars]), **implicitly()
+        ),
+    )
+    return Process(
+        argv=construct_oras_push_argv(
+            oras, os.path.normpath(os.path.join(ORAS_INPUT_DIR, downloaded_oras.exe)), request
+        ),
+        input_digest=request.input_digest,
+        immutable_input_digests={ORAS_INPUT_DIR: downloaded_oras.digest},
+        env=env,
+        description=f"Push {pluralize(len(request.files), 'file')} to {request.reference} with `oras`",
+        level=LogLevel.DEBUG,
+        # Publishing must run every time: the engine asserts this scope for non-interactive publish processes.
+        cache_scope=ProcessCacheScope.PER_SESSION,
+    )
+
+
+@rule(
+    desc="Uses `oras` to wrap PEX artifacts as an OCI artifact and push to the configured OCI registry.",
+    level=LogLevel.DEBUG,
+)
+async def publish_pex_as_oci_artifact(request: OrasPublishPexRequest) -> PublishProcesses:
+    """One interactive `oras push` per repository, each pushing every artifact `pants package` built."""
+    files = tuple(artifact.relpath for pkg in request.packages for artifact in pkg.artifacts if artifact.relpath)
+    if not files:
+        return PublishProcesses()
+
+    input_digest = await merge_digests(MergeDigests(pkg.digest for pkg in request.packages))
+    field_set = request.field_set
+    push_requests = tuple(
+        OrasPushRequest(
+            repository=repository,
+            tags=field_set.oci_tags.value or (),
+            files=files,
+            input_digest=input_digest,
+            artifact_type=field_set.oci_media_type.value,
+        )
+        for repository in field_set.oci_repositories.value or ()
+    )
+    processes = await concurrently(
+        setup_oras_push_process(push_request, **implicitly()) for push_request in push_requests
+    )
+    return PublishProcesses(
+        PublishPackages(
+            names=files,
+            process=InteractiveProcess.from_process(process),
+            description=push_request.reference,
+            data=PublishOutputData({"repository": push_request.repository, "tags": push_request.tags}),
+        )
+        for push_request, process in zip(push_requests, processes, strict=True)
+    )
+
+
+def rules() -> CollectedRules:
+    """Returns the `publish`-goal-specific rules for the `oras` pants plugin."""
+    return (*collect_rules(), *OrasPublishPexFieldSet.rules(), UnionRule(CheckSkipRequest, OrasPublishSkipRequest))

oras_pants_plugin/register.py

@@ -0,0 +1,20 @@
+"""Backend entry point: Pants loads this module when `oras_pants_plugin` is in `backend_packages`."""
+
+from typing import TYPE_CHECKING
+
+from oras_pants_plugin.fields import rules as field_rules
+from oras_pants_plugin.goals.publish import rules as publish_rules
+from oras_pants_plugin.subsystem import rules as subsystem_rules
+
+if TYPE_CHECKING:
+    from pants_plugin_developer_utils import CollectedRules, CollectedTargetTypes
+
+
+def rules() -> CollectedRules:
+    """Return every rule this backend registers with the Pants engine."""
+    return (*field_rules(), *publish_rules(), *subsystem_rules())
+
+
+def target_types() -> CollectedTargetTypes:
+    """The plugin adds fields to the builtin `pex_binary` targets and registers no target types of its own."""
+    return ()

oras_pants_plugin/subsystem.py

@@ -0,0 +1,84 @@
+"""The `oras` subsystem: where the binary comes from and how `pants publish` runs it."""
+
+from typing import TYPE_CHECKING, Final
+
+from pants.core.goals.resolves import ExportableTool
+from pants.core.util_rules.external_tool import TemplatedExternalTool
+from pants.engine.platform import Platform
+from pants.engine.rules import collect_rules
+from pants.engine.unions import UnionRule
+from pants.option.option_types import ArgsListOption, SkipOption, StrListOption
+from pants.util.strutil import softwrap
+
+if TYPE_CHECKING:
+    from pants_plugin_developer_utils import CollectedRules
+
+ORAS_BASE_ENV_VAR_NAMES: Final[tuple[str, ...]] = ("PATH", "HOME", "DOCKER_CONFIG")
+"""
+Always passed to `oras` processes. `oras` reads the credentials `docker login` and `oras login` store in
+`$DOCKER_CONFIG/config.json` or `~/.docker/config.json`, and runs the credential helpers named there from `PATH`.
+"""
+
+
+class Oras(TemplatedExternalTool):
+    """
+    The configuration and tooling wrapper for the `oras` binary to publish arbitrary artifacts as OCI artifacts in
+    OCI-compliant registries. See also: https://oras.land/docs/
+    """
+
+    options_scope = "oras"
+    name = "oras"
+    help = "The `oras` CLI for pushing files to OCI registries as OCI artifacts (https://oras.land/)."
+
+    default_version = "1.3.4"
+    # Compute with: `curl -L $URL | tee >(wc -c) >(shasum -a 256) >/dev/null`
+    # Pants declares these class attributes without `ClassVar`, so `ty` rejects a `ClassVar` annotation here.
+    default_known_versions = [  # noqa: RUF012
+        "1.3.4|linux_arm64 |15702c6e3a4a56a8bd8ac5c17efdbcab56d9bada661ccbcf017f5b10c1d89399|4238235",
+        "1.3.4|linux_x86_64|f27adb935022d94df8dc77719c322dda592c78a0d57a6f7dcdd8d900b248c454|4679642",
+        "1.3.4|macos_arm64 |217761a9500242ff473de8656b5aca21136ff39e17e9e61fd8936bbfd902704c|4401355",
+        "1.3.4|macos_x86_64|5e964f3d5a36eb9499a9d3e252a86b09e7adf3e6f6447eec56fd249c6702af7e|4750901",
+    ]
+    version_constraints = ">=1.3,<2"
+    default_url_template = (
+        "https://github.com/oras-project/oras/releases/download/v{version}/oras_{version}_{platform}.tar.gz"
+    )
+    # Go binaries are statically linked, so one Linux build runs on any distribution.
+    default_url_platform_mapping: dict[str, str] = {  # noqa: RUF012
+        "linux_arm64": "linux_arm64",
+        "linux_x86_64": "linux_amd64",
+        "macos_arm64": "darwin_arm64",
+        "macos_x86_64": "darwin_amd64",
+    }
+
+    skip = SkipOption("publish")
+    args = ArgsListOption(
+        example="--registry-config /path/to/auth.json --plain-http",
+        extra_help=softwrap(
+            """
+            Added to every `oras push` run by `pants publish`, after the plugin's own flags
+            (https://oras.land/docs/commands/oras_push). A repeated flag overrides the plugin's value.
+            """
+        ),
+    )
+    extra_env_vars = StrListOption(
+        default=[],
+        advanced=True,
+        help=softwrap(
+            """
+            Additional environment variables to make available to `oras` processes. Entries are either strings
+            in the form `ENV_VAR=value` to use explicitly, or just `ENV_VAR` to copy the value from Pants's own
+            environment. `PATH`, `HOME` and `DOCKER_CONFIG` are always passed through, so the credentials stored
+            by `docker login` or `oras login` and their credential helpers are found. Use this for proxy or TLS
+            settings such as `HTTPS_PROXY` or `SSL_CERT_FILE`.
+            """
+        ),
+    )
+
+    def generate_exe(self, plat: Platform) -> str:
+        """The release tarball extracts the binary to its root, next to the license."""
+        return "./oras"
+
+
+def rules() -> CollectedRules:
+    return (*collect_rules(), UnionRule(ExportableTool, Oras))

oras_pants_plugin/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

oras_pants_plugin-0.1.0.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: oras-pants-plugin
+Version: 0.1.0
+Summary: A Pantsbuild plugin for publishing PEX binaries to OCI registries as OCI artifacts with oras.
+Author: Zach Gottesman
+Maintainer: zach-overflow
+License-Expression: Apache-2.0
+Project-URL: Bug Tracker, https://github.com/zach-overflow/pants-plugin-depot/issues
+Project-URL: Changelog, https://github.com/zach-overflow/pants-plugin-depot/blob/main/provides/oras-pants-plugin/CHANGELOG.md
+Project-URL: Repository, https://github.com/zach-overflow/pants-plugin-depot
+Keywords: oci,oci artifact,oras,pants,pants plugin,pantsbuild,pex,publish,registry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Software Distribution
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pants-plugin-developer-utils>=0.1.0
+Dynamic: license-file
+
+# oras-pants-plugin
+
+A [Pantsbuild](https://www.pantsbuild.org/) plugin that publishes the output of `pex_binary` targets to OCI
+registries as [OCI artifacts](https://oras.land/docs/concepts/artifact) with [`oras`](https://oras.land/). Any
+registry that stores OCI artifacts works: GitHub Container Registry, Docker Hub, Artifact Registry, ECR, ACR,
+Harbor, a local `registry:2`, and so on.
+
+## Installation
+
+Add the plugin to `pants.toml` and enable its backend next to the Python backend:
+
+```toml
+[GLOBAL]
+plugins = ["oras-pants-plugin==<version>"]
+backend_packages.add = ["pants.backend.python", "oras_pants_plugin"]
+```
+
+Tell a `pex_binary` target where to push:
+
+```python
+# src/app/BUILD
+pex_binary(
+    name="app",
+    entry_point="main.py",
+    oci_repositories=["ghcr.io/my-org/app"],
+    oci_tags=["1.2.0", "latest"],
+)
+```
+
+Then build and push it through the `publish` goal:
+
+```bash
+pants publish src/app:app
+```
+
+Pull it back anywhere with `oras pull ghcr.io/my-org/app:1.2.0`, which restores `app.pex`.
+
+## How it works
+
+`oras` is downloaded as a static binary; nothing is installed into a Pants resolve. For every `pex_binary`
+target that lists `oci_repositories`, `pants publish`:
+
+1. Packages the target as `pants package` would. A target without `oci_repositories`, with `skip_oras=True`,
+   or run with `[oras].skip = true` is skipped before it is packaged.
+2. Runs one `oras push` per `oci_repositories` entry, in the foreground so `oras` can show progress. Every
+   artifact `pants package` produced for the target (the PEX, plus any `scie` executables) becomes a layer of
+   one OCI artifact, which is tagged with every `oci_tags` entry at once. The manifest's `artifactType` is the
+   target's `oci_media_type`.
+3. Reports each push as published, failed or skipped, like every other publisher. `--publish-output` writes the
+   same as JSON, with the `repository` and `tags` of each push.
+
+A `packed` or `loose` layout PEX is a directory, which `oras` pushes as a gzipped tar layer and `oras pull`
+unpacks again. The layer media types are left to `oras`.
+
+### Target fields
+
+| Field              | Target                       | Purpose                                                                                                                                                                       |
+| :----------------- | :--------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `oci_repositories` | `pex_binary`, `pex_binaries` | `<registry>/<repository>` references to push to, such as `ghcr.io/my-org/app` or `localhost:5000/app`. One push per entry. A reference MUST NOT carry a tag or digest.        |
+| `oci_tags`         | `pex_binary`, `pex_binaries` | Tags applied to the artifact in every repository. Default: `["latest"]`. `[]` pushes the artifact untagged, addressable by digest only.                                       |
+| `oci_media_type`   | `pex_binary`, `pex_binaries` | The `artifactType` of the pushed manifest, passed as `--artifact-type`. Default: `application/vnd.python.pex.v1`.                                                             |
+| `skip_oras`        | `pex_binary`, `pex_binaries` | If true, the target is skipped by `pants publish`.                                                                                                                            |
+| `overrides`        | `pex_binaries`               | Per-binary values for the fields above, e.g. `overrides={"tool.py": {"skip_oras": True}}`. On `pex_binaries` the fields apply to every generated `pex_binary`.               |
+
+## Configuration
+
+| Option                     | Default         | Purpose                                                                                                                                        |
+| :------------------------- | :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
+| `[oras].skip`              | `false`         | Skip `oras` during `pants publish`.                                                                                                            |
+| `[oras].args`              | `[]`            | Extra arguments for every `oras push`, e.g. `--plain-http` or `--registry-config /path/to/auth.json`. They follow the plugin's own flags, so a repeated flag overrides it. |
+| `[oras].extra_env_vars`    | `[]`            | Extra environment variables for `oras`, as `NAME=value` or `NAME` to copy from Pants' environment, e.g. `HTTPS_PROXY` or `SSL_CERT_FILE`.     |
+| `[oras].version`           | bundled default | `oras` release to download.                                                                                                                    |
+| `[oras].known_versions`    | bundled default | Checksums of downloadable releases; extend to use another version.                                                                             |
+
+### Credentials
+
+`oras` reads the credentials that `docker login` or `oras login` store in `$DOCKER_CONFIG/config.json` or
+`~/.docker/config.json`, and runs the credential helpers configured there. `PATH`, `HOME` and `DOCKER_CONFIG`
+are always passed to `oras`, so logging in once is enough:
+
+```bash
+oras login ghcr.io          # or: docker login ghcr.io
+pants publish src/app:app
+```
+
+In CI, pass the token to a login step before `pants publish`, or point `[oras].args` at an auth file with
+`--registry-config`. Avoid `--username`/`--password` in `pants.toml`: the file is committed.
+
+### Pushing to a directory
+
+`oras` can write to an [OCI image layout](https://github.com/opencontainers/image-spec/blob/main/image-layout.md)
+directory instead of a registry, which is handy for inspecting what would be pushed:
+
+```bash
+pants --oras-args="['--oci-layout-path', '/tmp/app-layout']" publish src/app:app
+```
+
+The reference in `oci_repositories` is kept as the tag name inside the layout.
+
+### Using a different `oras` version
+
+Add the release's checksums and sizes to `known_versions` and set `version`:
+
+```toml
+[oras]
+version = "1.3.5"
+known_versions.add = [
+  "1.3.5|linux_arm64 |<sha256>|<size>",
+  "1.3.5|linux_x86_64|<sha256>|<size>",
+  "1.3.5|macos_arm64 |<sha256>|<size>",
+  "1.3.5|macos_x86_64|<sha256>|<size>",
+]
+```
+
+Compute each line with `curl -L $URL | tee >(wc -c) >(shasum -a 256) >/dev/null`, where `$URL` is the
+`oras_<version>_<os>_<arch>.tar.gz` asset of the
+[GitHub release](https://github.com/oras-project/oras/releases) (`linux`/`darwin`, `amd64`/`arm64`). The
+release's `oras_<version>_checksums.txt` lists the same checksums.
+
+## Supported versions
+
+| Plugin | Pants  | Python | `oras`     |
+| :----- | :----- | :----- | :--------- |
+| `0.x`  | `2.33` | `3.14` | `>=1.3,<2` |
+
+Pants loads plugins into its own interpreter, so the plugin requires the Python version Pants runs on. The PEX
+being published may target any Python version.
+
+## Releases
+
+Wheels are published to [PyPI](https://pypi.org/project/oras-pants-plugin/). Release notes live in the
+[changelog](https://github.com/zach-overflow/pants-plugin-depot/blob/main/provides/oras-pants-plugin/CHANGELOG.md)
+and on the [GitHub releases page](https://github.com/zach-overflow/pants-plugin-depot/releases).
+
+## Contributing, Bug Reports and Feature Requests
+
+This plugin lives in the [pants-plugin-depot](https://github.com/zach-overflow/pants-plugin-depot) repo.
+See its [CONTRIBUTING.md](https://github.com/zach-overflow/pants-plugin-depot/blob/main/CONTRIBUTING.md), or
+open an [issue](https://github.com/zach-overflow/pants-plugin-depot/issues/new/choose).

oras_pants_plugin-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+oras_pants_plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oras_pants_plugin/fields.py,sha256=2aHICEvew7-AW1PZWmIcWOXifX98aJ9TdMfV_yAKhq4,4374
+oras_pants_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oras_pants_plugin/register.py,sha256=YBxqBDYmCUldPCt7TuAGgYwDop6Bf4mkjRGqoa4CxvI,772
+oras_pants_plugin/subsystem.py,sha256=OjWuS7D7rrnJpOGcMtQ-TnN76QcMckJBGCroD_NI1ug,3783
+oras_pants_plugin/version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+oras_pants_plugin/goals/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oras_pants_plugin/goals/publish.py,sha256=vtgzsa4xU_8NtWp-yZWF4QXUMxcxhEOlghmTtqxf-bo,8427
+oras_pants_plugin-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oras_pants_plugin-0.1.0.dist-info/METADATA,sha256=dATDjCLCDiYf8VHrJIhs8WOxfEo2P4m9oy5RcesWkM4,8855
+oras_pants_plugin-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+oras_pants_plugin-0.1.0.dist-info/top_level.txt,sha256=OyVbti6SvqLNhscUwlw3jFiyXn6ZwXaShtubLVa4sFE,18
+oras_pants_plugin-0.1.0.dist-info/RECORD,,

oras_pants_plugin-0.1.0.dist-info/WHEEL

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

oras_pants_plugin-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

oras_pants_plugin-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+oras_pants_plugin