Skip to content

Commit 5276297

Browse files
committed
deploy: 6529ab5
1 parent d1db17f commit 5276297

File tree

5 files changed

+46
-11
lines changed

5 files changed

+46
-11
lines changed

.doctrees/environment.pickle

2.92 KB
Binary file not shown.
2.14 KB
Binary file not shown.

_sources/tutorials/get-to-know-hatch.md.txt

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,34 @@ Our Python packaging tutorials use the tool Hatch.
44
In this tutorial, you will install and get to know hatch a bit more before starting to use it.
55

66
## Install Hatch
7-
To begin, install Hatch following the
8-
[instructions here](https://hatch.pypa.io/latest/install/).
7+
To begin, install Hatch from the command line using [pipx](https://pipx.pypa.io/stable/)
8+
9+
```bash
10+
pipx install hatch
11+
```
912

1013
:::{tip}
11-
If you are comfortable using [pipx](https://pipx.pypa.io/stable/) 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.
14+
Hatch also provides pre-build binaries available from common OS package managers or directly from
15+
the [hatch website](https://hatch.pypa.io/latest/install/).
16+
:::
1217

13-
However if you are not sure about pipx, you can install hatch using pip or conda.
18+
:::{tip}
19+
Hatch can also be installed directly using `pip` or `conda`, but we encourage you to use `pipx`.
20+
This is because `pipx` will ensure that your package is available across all of your Python
21+
environments on your computer rather than just in the environment that you install it into.
22+
If you install hatch this way you will have to take care that the environment it is installed into
23+
is activated for the command to work.
1424
:::
1525

26+
You can check that hatch is working properly by issuing a simple command to get the version
27+
28+
```bash
29+
hatch --version
30+
# Hatch, version 1.9.4
31+
```
32+
33+
Note the version numbers will likely be different
34+
1635
## Configure hatch
1736

1837
Once you have installed hatch, you will want to customize the configuration.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tutorials/get-to-know-hatch.html

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
<meta property="og:type" content="website" />
1212
<meta property="og:url" content="https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html" />
1313
<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..." />
1515
<meta property="og:image:width" content="1146" />
1616
<meta property="og:image:height" content="600" />
1717
<meta property="og:image" content="https://www.pyopensci.org/python-package-guide/_images/social_previews/summary_tutorials_get-to-know-hatch_ac6f425b.png" />
1818
<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..." />
2020
<meta name="twitter:card" content="summary_large_image" />
2121
<link href="https://www.pyopensci.org/images/favicon.ico" rel="icon" type="image/x-icon">
2222
<title>Get to know hatch &#8212; Python Packaging Guide</title>
@@ -520,13 +520,29 @@ <h1>Get to know hatch<a class="headerlink" href="#get-to-know-hatch" title="Link
520520
In this tutorial, you will install and get to know hatch a bit more before starting to use it.</p>
521521
<section id="install-hatch">
522522
<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>
525527
<div class="admonition tip">
526528
<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>
529544
</div>
545+
<p>Note the version numbers will likely be different</p>
530546
</section>
531547
<section id="configure-hatch">
532548
<h2>Configure hatch<a class="headerlink" href="#configure-hatch" title="Link to this heading">#</a></h2>

0 commit comments

Comments
 (0)