feat: adds support for custom sources for Python distributions (#1455)

Co-authored-by: Ofek Lev <[email protected]> c84d7b3

dev/cli/reference/index.html

@@ -45,7 +45,7 @@
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--repo</code>, <code>-r</code></td> <td>text</td> <td>The repository with which to publish artifacts [env var: <code>HATCH_INDEX_REPO</code>]</td> <td>None</td> </tr> <tr> <td><code>--user</code>, <code>-u</code></td> <td>text</td> <td>The user with which to authenticate [env var: <code>HATCH_INDEX_USER</code>]</td> <td>None</td> </tr> <tr> <td><code>--auth</code>, <code>-a</code></td> <td>text</td> <td>The credentials to use for authentication [env var: <code>HATCH_INDEX_AUTH</code>]</td> <td>None</td> </tr> <tr> <td><code>--ca-cert</code></td> <td>text</td> <td>The path to a CA bundle [env var: <code>HATCH_INDEX_CA_CERT</code>]</td> <td>None</td> </tr> <tr> <td><code>--client-cert</code></td> <td>text</td> <td>The path to a client certificate, optionally containing the private key [env var: <code>HATCH_INDEX_CLIENT_CERT</code>]</td> <td>None</td> </tr> <tr> <td><code>--client-key</code></td> <td>text</td> <td>The path to the client certificate's private key [env var: <code>HATCH_INDEX_CLIENT_KEY</code>]</td> <td>None</td> </tr> <tr> <td><code>--no-prompt</code>, <code>-n</code></td> <td>boolean</td> <td>Disable prompts, such as for missing required fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--initialize-auth</code></td> <td>boolean</td> <td>Save first-time authentication information even if nothing was published</td> <td><code>False</code></td> </tr> <tr> <td><code>--publisher</code>, <code>-p</code></td> <td>text</td> <td>The publisher plugin to use (default is <code>index</code>) [env var: <code>HATCH_PUBLISHER</code>]</td> <td><code>index</code></td> </tr> <tr> <td><code>--option</code>, <code>-o</code></td> <td>text</td> <td>Options to pass to the publisher plugin. This may be selected multiple times e.g. <code>-o foo=bar -o baz=23</code> [env var: <code>HATCH_PUBLISHER_OPTIONS</code>]</td> <td>None</td> </tr> <tr> <td><code>--yes</code>, <code>-y</code></td> <td>boolean</td> <td>Confirm without prompting when the plugin is disabled</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-python>hatch python<a class=headerlink href=#hatch-python title="Permanent link">&para;</a></h2> <p>Manage Python installations</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python [OPTIONS] COMMAND [ARGS]...
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-find>hatch python find<a class=headerlink href=#hatch-python-find title="Permanent link">&para;</a></h3> <p>Locate Python binaries.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python find [OPTIONS] NAME
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>-p</code>, <code>--parent</code></td> <td>boolean</td> <td>Show the parent directory of the Python binary</td> <td><code>False</code></td> </tr> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-install>hatch python install<a class=headerlink href=#hatch-python-install title="Permanent link">&para;</a></h3> <p>Install Python distributions.</p> <p>You may select <code>all</code> to install all compatible distributions:</p> <div class=highlight><pre><span></span><code>hatch python install all
-</code></pre></div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python install [OPTIONS] NAMES...
+</code></pre></div> <p>You can set custom sources for distributions by setting the <code>HATCH_PYTHON_SOURCE_&lt;NAME&gt;</code> environment variable where <code>&lt;NAME&gt;</code> is the uppercased version of the distribution name with periods replaced by underscores e.g. <code>HATCH_PYTHON_SOURCE_PYPY3_10</code>.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python install [OPTIONS] NAMES...
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--private</code></td> <td>boolean</td> <td>Do not add distributions to the user PATH</td> <td><code>False</code></td> </tr> <tr> <td><code>--update</code>, <code>-u</code></td> <td>boolean</td> <td>Update existing installations</td> <td><code>False</code></td> </tr> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which to install distributions, overriding configuration</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-remove>hatch python remove<a class=headerlink href=#hatch-python-remove title="Permanent link">&para;</a></h3> <p>Remove Python distributions.</p> <p>You may select <code>all</code> to remove all installed distributions:</p> <div class=highlight><pre><span></span><code>hatch python remove all
 </code></pre></div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python remove [OPTIONS] NAMES...
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-show>hatch python show<a class=headerlink href=#hatch-python-show title="Permanent link">&para;</a></h3> <p>Show the available Python distributions.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python show [OPTIONS]