|
11 | 11 | <meta property="og:type" content="website" /> |
12 | 12 | <meta property="og:url" content="https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html" /> |
13 | 13 | <meta property="og:site_name" content="pyOpenSci Python Package Guide" /> |
14 | | -<meta property="og:description" content="Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. Install Hatch: To begin, install Hatch following th..." /> |
| 14 | +<meta property="og:description" content="Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. Install Hatch: To begin, install Hatch from the com..." /> |
15 | 15 | <meta property="og:image:width" content="1146" /> |
16 | 16 | <meta property="og:image:height" content="600" /> |
17 | 17 | <meta property="og:image" content="https://www.pyopensci.org/python-package-guide/_images/social_previews/summary_tutorials_get-to-know-hatch_ac6f425b.png" /> |
18 | 18 | <meta property="og:image:alt" content="Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. Install Hat..." /> |
19 | | -<meta name="description" content="Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. Install Hatch: To begin, install Hatch following th..." /> |
| 19 | +<meta name="description" content="Our Python packaging tutorials use the tool Hatch. In this tutorial, you will install and get to know hatch a bit more before starting to use it. Install Hatch: To begin, install Hatch from the com..." /> |
20 | 20 | <meta name="twitter:card" content="summary_large_image" /> |
21 | 21 | <link href="https://www.pyopensci.org/images/favicon.ico" rel="icon" type="image/x-icon"> |
22 | 22 | <title>Get to know hatch — Python Packaging Guide</title> |
@@ -520,13 +520,29 @@ <h1>Get to know hatch<a class="headerlink" href="#get-to-know-hatch" title="Link |
520 | 520 | In this tutorial, you will install and get to know hatch a bit more before starting to use it.</p> |
521 | 521 | <section id="install-hatch"> |
522 | 522 | <h2>Install Hatch<a class="headerlink" href="#install-hatch" title="Link to this heading">#</a></h2> |
523 | | -<p>To begin, install Hatch following the |
524 | | -<a class="reference external" href="https://hatch.pypa.io/latest/install/">instructions here</a>.</p> |
| 523 | +<p>To begin, install Hatch from the command line using <a class="reference external" href="https://pipx.pypa.io/stable/">pipx</a></p> |
| 524 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pipx<span class="w"> </span>install<span class="w"> </span>hatch |
| 525 | +</pre></div> |
| 526 | +</div> |
525 | 527 | <div class="admonition tip"> |
526 | 528 | <p class="admonition-title">Tip</p> |
527 | | -<p>If you are comfortable using <a class="reference external" href="https://pipx.pypa.io/stable/">pipx</a> to install hatch, we encourage you to do so. pipx will ensure that your package is available across all of your Python environments on your computer rather than just in the environment that you install it into.</p> |
528 | | -<p>However if you are not sure about pipx, you can install hatch using pip or conda.</p> |
| 529 | +<p>Hatch also provides pre-build binaries available from common OS package managers or directly from |
| 530 | +the <a class="reference external" href="https://hatch.pypa.io/latest/install/">hatch website</a>.</p> |
| 531 | +</div> |
| 532 | +<div class="admonition tip"> |
| 533 | +<p class="admonition-title">Tip</p> |
| 534 | +<p>Hatch can also be installed directly using <code class="docutils literal notranslate"><span class="pre">pip</span></code> or <code class="docutils literal notranslate"><span class="pre">conda</span></code>, but we encourage you to use <code class="docutils literal notranslate"><span class="pre">pipx</span></code>. |
| 535 | +This is because <code class="docutils literal notranslate"><span class="pre">pipx</span></code> will ensure that your package is available across all of your Python |
| 536 | +environments on your computer rather than just in the environment that you install it into. |
| 537 | +If you install hatch this way you will have to take care that the environment it is installed into |
| 538 | +is activated for the command to work.</p> |
| 539 | +</div> |
| 540 | +<p>You can check that hatch is working properly by issuing a simple command to get the version</p> |
| 541 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>hatch<span class="w"> </span>--version |
| 542 | +<span class="c1"># Hatch, version 1.9.4</span> |
| 543 | +</pre></div> |
529 | 544 | </div> |
| 545 | +<p>Note the version numbers will likely be different</p> |
530 | 546 | </section> |
531 | 547 | <section id="configure-hatch"> |
532 | 548 | <h2>Configure hatch<a class="headerlink" href="#configure-hatch" title="Link to this heading">#</a></h2> |
|
0 commit comments