Update documentation

latest/.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: cdbeae548dcd31cf5affd0f9d236d067
+config: a52e71e9a69f0130eaaff724882530e7
 tags: 645f666f9bcd5a90fca523b33c5a78b7

latest/genindex.html

@@ -130,12 +130,14 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="methoddocs/contract_type.html#ethpm_types.contract_type.ABILIST_T">ABILIST_T (in module ethpm_types.contract_type)</a>
 </li>
-      <li><a href="methoddocs/utils.html#ethpm_types.utils.Algorithm">Algorithm (class in ethpm_types.utils)</a>
+      <li><a href="methoddocs/manifest.html#ethpm_types.manifest.PackageManifest.add_compilers">add_compilers() (ethpm_types.manifest.PackageManifest method)</a>
 </li>
-      <li><a href="methoddocs/source.html#ethpm_types.source.Checksum.algorithm">algorithm (ethpm_types.source.Checksum attribute)</a>
+      <li><a href="methoddocs/utils.html#ethpm_types.utils.Algorithm">Algorithm (class in ethpm_types.utils)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/source.html#ethpm_types.source.Checksum.algorithm">algorithm (ethpm_types.source.Checksum attribute)</a>
+</li>
       <li><a href="methoddocs/abi.html#ethpm_types.abi.EventABI.anonymous">anonymous (ethpm_types.abi.EventABI attribute)</a>
 </li>
       <li><a href="methoddocs/contract_type.html#ethpm_types.contract_type.ContractType.ast">ast (ethpm_types.contract_type.ContractType attribute)</a>
@@ -328,10 +330,12 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/source.html#ethpm_types.source.Function.get_content">get_content() (ethpm_types.source.Function method)</a>
+</li>
+      <li><a href="methoddocs/source.html#ethpm_types.source.Function.get_content_asts">get_content_asts() (ethpm_types.source.Function method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/source.html#ethpm_types.source.Function.get_content_asts">get_content_asts() (ethpm_types.source.Function method)</a>
+      <li><a href="methoddocs/manifest.html#ethpm_types.manifest.PackageManifest.get_contract_compiler">get_contract_compiler() (ethpm_types.manifest.PackageManifest method)</a>
 </li>
       <li><a href="methoddocs/manifest.html#ethpm_types.manifest.PackageManifest.get_contract_type">get_contract_type() (ethpm_types.manifest.PackageManifest method)</a>
 </li>

latest/methoddocs/manifest.html

@@ -103,6 +103,20 @@
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ethpm_types.manifest.</span></span><span class="sig-name descname"><span class="pre">PackageManifest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manifest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'ethpm/3'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ethpm_types.manifest.PackageName" title="ethpm_types.manifest.PackageName"><span class="pre">ethpm_types.manifest.PackageName</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ethpm_types.manifest.PackageMeta" title="ethpm_types.manifest.PackageMeta"><span class="pre">ethpm_types.manifest.PackageMeta</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="source.html#ethpm_types.source.Source" title="ethpm_types.source.Source"><span class="pre">ethpm_types.source.Source</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contractTypes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="contract_type.html#ethpm_types.contract_type.ContractType" title="ethpm_types.contract_type.ContractType"><span class="pre">ethpm_types.contract_type.ContractType</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compilers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">ethpm_types.source.Compiler</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="contract_type.html#ethpm_types.contract_type.BIP122_URI" title="ethpm_types.contract_type.BIP122_URI"><span class="pre">ethpm_types.contract_type.BIP122_URI</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ethpm_types.contract_type.ContractInstance</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buildDependencies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ethpm_types.manifest.PackageName" title="ethpm_types.manifest.PackageName"><span class="pre">ethpm_types.manifest.PackageName</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">pydantic.v1.networks.AnyUrl</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">pydantic.v1.networks.FileUrl</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ethpm_types.manifest.PackageManifest" title="Permalink to this definition"></a></dt>
 <dd><p>A data format describing a smart contract software package.</p>
 <p><a class="reference external" href="https://eips.ethereum.org/EIPS/eip-2678#ethpm-manifest-version">EIP-2678</a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="ethpm_types.manifest.PackageManifest.add_compilers">
+<span class="sig-name descname"><span class="pre">add_compilers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">compilers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ethpm_types.source.Compiler</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ethpm_types.manifest.PackageManifest.add_compilers" title="Permalink to this definition"></a></dt>
+<dd><p>Update compilers in the manifest. This method appends any
+given compiler with a a different name, version, and settings
+combination.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>compilers</strong> (List[<cite>~ethpm_types.source.Compiler]</cite>) – A list of
+compilers.</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="ethpm_types.manifest.PackageManifest.compilers">
 <span class="sig-name descname"><span class="pre">compilers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">ethpm_types.source.Compiler</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ethpm_types.manifest.PackageManifest.compilers" title="Permalink to this definition"></a></dt>
@@ -151,6 +165,20 @@
 <dd><p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="ethpm_types.manifest.PackageManifest.get_contract_compiler">
+<span class="sig-name descname"><span class="pre">get_contract_compiler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contract_type_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">ethpm_types.source.Compiler</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#ethpm_types.manifest.PackageManifest.get_contract_compiler" title="Permalink to this definition"></a></dt>
+<dd><p>Get the compiler used to compile the contract type, if it exists.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>contract_type_name</strong> (<em>str</em>) – The name of the compiled contract.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>Optional[<cite>~ethpm_types.source.Compiler</cite>]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="ethpm_types.manifest.PackageManifest.get_contract_type">
 <span class="sig-name descname"><span class="pre">get_contract_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="contract_type.html#ethpm_types.contract_type.ContractType" title="ethpm_types.contract_type.ContractType"><span class="pre">ethpm_types.contract_type.ContractType</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#ethpm_types.manifest.PackageManifest.get_contract_type" title="Permalink to this definition"></a></dt>