Deploying to gh-pages from @ 7c68048 🚀

oras-project · May 22, 2024 · 4926631 · 4926631
1 parent c2e15c9
commit 4926631
Show file tree

Hide file tree

Showing 39 changed files with 825 additions and 573 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 727c4acbbf910758c5696b56540da7c3
+config: 39788230cfef4bfc0d6089cf78461274
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/functools.html b/_modules/functools.html
@@ -46,7 +46,7 @@
   <link href="../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../_static/doctools.js?v=888ff710">
+  <script src="../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -1324,13 +1324,13 @@ <h1 id="modules-functools--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/index.html b/_modules/index.html
@@ -46,7 +46,7 @@
   <link href="../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../_static/doctools.js?v=888ff710">
+  <script src="../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -380,13 +380,13 @@ <h1 id="modules-index--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/auth.html b/_modules/oras/auth.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -407,13 +407,13 @@ <h1 id="modules-oras-auth--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/client.html b/_modules/oras/client.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -588,13 +588,13 @@ <h1 id="modules-oras-client--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/container.html b/_modules/oras/container.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -454,13 +454,13 @@ <h1 id="modules-oras-container--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/decorator.html b/_modules/oras/decorator.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -407,13 +407,13 @@ <h1 id="modules-oras-decorator--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/defaults.html b/_modules/oras/defaults.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -363,13 +363,13 @@ <h1 id="modules-oras-defaults--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/logger.html b/_modules/oras/logger.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -675,13 +675,13 @@ <h1 id="modules-oras-logger--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/main/login.html b/_modules/oras/main/login.html
@@ -46,7 +46,7 @@
   <link href="../../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../../_static/doctools.js?v=888ff710">
+  <script src="../../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -370,13 +370,13 @@ <h1 id="modules-oras-main-login--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/oci.html b/_modules/oras/oci.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -298,7 +298,10 @@ <h1 id="modules-oras-oci--page-root">
 <span class="n">__license__</span> <span class="o">=</span> <span class="s2">"Apache-2.0"</span>
 
 <span class="kn">import</span> <span class="nn">copy</span>
+<span class="kn">import</span> <span class="nn">hashlib</span>
+<span class="kn">import</span> <span class="nn">json</span>
 <span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span>
 
 <span class="kn">import</span> <span class="nn">jsonschema</span>
@@ -476,6 +479,36 @@ <h1 id="modules-oras-oci--page-root">
 <span class="sd">    """</span>
     <span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">EmptyManifest</span><span class="p">)</span></div>
 
+
+
+<div class="viewcode-block" id="Subject">
+<a class="viewcode-back" href="../../source/oras.html#oras.oci.Subject">[docs]</a>
+<span class="nd">@dataclass</span>
+<span class="k">class</span> <span class="nc">Subject</span><span class="p">:</span>
+    <span class="n">mediaType</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">digest</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">size</span><span class="p">:</span> <span class="nb">int</span>
+
+<div class="viewcode-block" id="Subject.from_manifest">
+<a class="viewcode-back" href="../../source/oras.html#oras.oci.Subject.from_manifest">[docs]</a>
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">from_manifest</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">manifest</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">"Subject"</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">"""</span>
+<span class="sd">        Create a new Subject from a Manifest</span>
+
+<span class="sd">        :param manifest: manifest to convert to subject</span>
+<span class="sd">        """</span>
+        <span class="n">manifest_string</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">manifest</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
+        <span class="n">digest</span> <span class="o">=</span> <span class="s2">"sha256:"</span> <span class="o">+</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">manifest_string</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
+        <span class="n">size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">manifest_string</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span>
+            <span class="n">manifest</span><span class="p">[</span><span class="s2">"mediaType"</span><span class="p">]</span> <span class="ow">or</span> <span class="n">oras</span><span class="o">.</span><span class="n">defaults</span><span class="o">.</span><span class="n">default_manifest_media_type</span><span class="p">,</span>
+            <span class="n">digest</span><span class="p">,</span>
+            <span class="n">size</span><span class="p">,</span>
+        <span class="p">)</span></div>
+</div>
+
 </pre>
        </div>
       </article>
@@ -495,13 +528,13 @@ <h1 id="modules-oras-oci--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/provider.html b/_modules/oras/provider.html
@@ -46,7 +46,7 @@
   <link href="../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../_static/doctools.js?v=888ff710">
+  <script src="../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -301,7 +301,7 @@ <h1 id="modules-oras-provider--page-root">
 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">urllib</span>
 <span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">contextmanager</span><span class="p">,</span> <span class="n">nullcontext</span>
-<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">asdict</span><span class="p">,</span> <span class="n">dataclass</span>
+<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">asdict</span>
 <span class="kn">from</span> <span class="nn">http.cookiejar</span> <span class="kn">import</span> <span class="n">DefaultCookiePolicy</span>
 <span class="kn">from</span> <span class="nn">tempfile</span> <span class="kn">import</span> <span class="n">TemporaryDirectory</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Generator</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
@@ -333,16 +333,6 @@ <h1 id="modules-oras-provider--page-root">
 
 
 
-<div class="viewcode-block" id="Subject">
-<a class="viewcode-back" href="../../source/oras.html#oras.provider.Subject">[docs]</a>
-<span class="nd">@dataclass</span>
-<span class="k">class</span> <span class="nc">Subject</span><span class="p">:</span>
-    <span class="n">mediaType</span><span class="p">:</span> <span class="nb">str</span>
-    <span class="n">digest</span><span class="p">:</span> <span class="nb">str</span>
-    <span class="n">size</span><span class="p">:</span> <span class="nb">int</span></div>
-
-
-
 <div class="viewcode-block" id="Registry">
 <a class="viewcode-back" href="../../source/oras.html#oras.provider.Registry">[docs]</a>
 <span class="k">class</span> <span class="nc">Registry</span><span class="p">:</span>
@@ -1032,7 +1022,7 @@ <h1 id="modules-oras-provider--page-root">
 <span class="sd">        :param refresh_headers: if true or None, headers are refreshed</span>
 <span class="sd">        :type refresh_headers: bool</span>
 <span class="sd">        :param subject: optional subject reference</span>
-<span class="sd">        :type subject: Subject</span>
+<span class="sd">        :type subject: oras.oci.Subject</span>
 <span class="sd">        """</span>
         <span class="n">container</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_container</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">"target"</span><span class="p">])</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">load_configs</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="n">configs</span><span class="o">=</span><span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"config_path"</span><span class="p">))</span>
@@ -1458,13 +1448,13 @@ <h1 id="modules-oras-provider--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for

diff --git a/_modules/oras/tests/test_oras.html b/_modules/oras/tests/test_oras.html
@@ -46,7 +46,7 @@
   <link href="../../../_static/custom.css?v=d68d0989" rel="stylesheet" type="text/css"/>
   <script src="../../../_static/documentation_options.js?v=0e525676">
   </script>
-  <script src="../../../_static/doctools.js?v=888ff710">
+  <script src="../../../_static/doctools.js?v=9a2dae69">
   </script>
   <script src="../../../_static/sphinx_highlight.js?v=dc90522c">
   </script>
@@ -468,13 +468,13 @@ <h1 id="modules-oras-tests-test-oras--page-root">
        © Copyright 2023, Oras Python Developers.
       </div>
       Last updated on
-              Apr 05, 2024.
+              May 22, 2024.
       <br/>
       Created using
       <a href="http://www.sphinx-doc.org/">
        Sphinx
       </a>
-      7.2.6.
+      7.3.7.
              and
       <a href="https://github.com/bashtage/sphinx-material/">
        Material for