Merge branch 'main' into unique-package-name

lwasser · web-flow · commit 81ea657bb48f · 2024-05-30T18:30:11.000-06:00
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -533,6 +533,76 @@
         "code",
         "review"
       ]
+    },
+    {
+      "login": "kenseehart",
+      "name": "Ken Seehart",
+      "avatar_url": "https://avatars.githubusercontent.com/u/612119?v=4",
+      "profile": "https://github.com/kenseehart",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "ryanskeith",
+      "name": "Ryan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/657220?v=4",
+      "profile": "https://github.com/ryanskeith",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "pb-413",
+      "name": "Patrick Byers",
+      "avatar_url": "https://avatars.githubusercontent.com/u/36516871?v=4",
+      "profile": "https://github.com/pb-413",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "sosey",
+      "name": "Megan Sosey",
+      "avatar_url": "https://avatars.githubusercontent.com/u/503615?v=4",
+      "profile": "http://www.stsci.edu/",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "BSuperbad",
+      "name": "Brianne Wilhelmi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/100496041?v=4",
+      "profile": "https://github.com/BSuperbad",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "chenghlee",
+      "name": "Cheng H. Lee",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3485949?v=4",
+      "profile": "https://github.com/chenghlee",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "Vaunty",
+      "name": "Vaunty",
+      "avatar_url": "https://avatars.githubusercontent.com/u/68826427?v=4",
+      "profile": "https://github.com/Vaunty",
+      "contributions": [
+        "code",
+        "review"
+      ]
     }
   ],
   "contributorsPerLine": 7,
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # <img src="https://www.pyopensci.org/images/logo.png" width=100 /> pyOpenSci scientific Python Packaging Guide
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-51-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-58-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic)
@@ -140,6 +140,15 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/tylerjbonnell/"><img src="https://avatars.githubusercontent.com/u/89505514?v=4?s=100" width="100px;" alt="Tyler Bonnell"/><br /><sub><b>Tyler Bonnell</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Tyler-Bonnell" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ATyler-Bonnell" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/pub/pat-tressel/2/b6/610"><img src="https://avatars.githubusercontent.com/u/618916?v=4?s=100" width="100px;" alt="Pat Tressel"/><br /><sub><b>Pat Tressel</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ptressel" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aptressel" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/kenseehart"><img src="https://avatars.githubusercontent.com/u/612119?v=4?s=100" width="100px;" alt="Ken Seehart"/><br /><sub><b>Ken Seehart</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=kenseehart" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Akenseehart" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ryanskeith"><img src="https://avatars.githubusercontent.com/u/657220?v=4?s=100" width="100px;" alt="Ryan"/><br /><sub><b>Ryan</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ryanskeith" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aryanskeith" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pb-413"><img src="https://avatars.githubusercontent.com/u/36516871?v=4?s=100" width="100px;" alt="Patrick Byers"/><br /><sub><b>Patrick Byers</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=pb-413" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Apb-413" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.stsci.edu/"><img src="https://avatars.githubusercontent.com/u/503615?v=4?s=100" width="100px;" alt="Megan Sosey"/><br /><sub><b>Megan Sosey</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=sosey" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Asosey" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/BSuperbad"><img src="https://avatars.githubusercontent.com/u/100496041?v=4?s=100" width="100px;" alt="Brianne Wilhelmi"/><br /><sub><b>Brianne Wilhelmi</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=BSuperbad" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ABSuperbad" title="Reviewed Pull Requests">👀</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/chenghlee"><img src="https://avatars.githubusercontent.com/u/3485949?v=4?s=100" width="100px;" alt="Cheng H. Lee"/><br /><sub><b>Cheng H. Lee</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=chenghlee" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Achenghlee" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Vaunty"><img src="https://avatars.githubusercontent.com/u/68826427?v=4?s=100" width="100px;" alt="Vaunty"/><br /><sub><b>Vaunty</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Vaunty" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AVaunty" title="Reviewed Pull Requests">👀</a></td>
     </tr>
   </tbody>
 </table>
diff --git a/documentation/repository-files/readme-file-best-practices.md b/documentation/repository-files/readme-file-best-practices.md
@@ -6,7 +6,7 @@ sees before they install your package.
 
 The README.md file is the landing page of:
 
-* Your package as it appears on a repository site such as PyPI or Anaconda
+* Your package as it appears on a repository site such as PyPI or Anaconda.org
 * Your package's GitHub repository
 
 Your README.md file is also used as a measure of package and community
@@ -68,7 +68,7 @@ README file for others to quickly browse.
 
 Some badges that you might consider adding to your README file include:
 
-* Current version of the package on PyPI / Anaconda Cloud
+* Current version of the package on PyPI / Anaconda.org
 
 Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)
 
@@ -114,7 +114,7 @@ file.
 ### ✔️ Installation instructions
 
 Include instructions for installing your package. If you have published
-the package on both PyPI and Anaconda Cloud be sure to include instructions for both.
+the package on both PyPI and Anaconda.org, be sure to include instructions for both.
 
 ### ✔️ Document any additional setup required
 
diff --git a/package-structure-code/publish-python-package-pypi-conda.md b/package-structure-code/publish-python-package-pypi-conda.md
@@ -1,10 +1,10 @@
-# Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud
+# Publishing Your Package In A Community Repository: PyPI or Anaconda.org
 
 <!--todo: add as resource https://docs.conda.io/projects/conda/en/latest/glossary.html -->
 
 pyOpenSci requires that your package has an distribution that can be installed
 from a public community repository such as PyPI or a conda channel such as
-`bioconda` or `conda-forge` in the Anaconda cloud.
+`bioconda` or `conda-forge` on Anaconda.org.
 
 Below you will learn more about the various publishing options for your Python
 package.
@@ -13,7 +13,7 @@ package.
 
 * Installing packages in the same environment using both pip and conda can
 lead to package conflicts.
-* To minimize conflicts for users who may be using conda (or pip) to manage local environments, consider publishing your package to both PyPI and the conda-forge channel of the Anaconda Cloud.
+* To minimize conflicts for users who may be using conda (or pip) to manage local environments, consider publishing your package to both PyPI and the conda-forge channel on Anaconda.org.
 
 Below you will learn more specifics about the differences between PyPI and conda publishing of your Python package.
 :::
@@ -57,13 +57,13 @@ your package.
 :::
 
 (about-conda)=
-## What is Anaconda Cloud and conda?
+## What is conda and Anaconda.org?
 
 conda is an open source package and environment management tool.
-conda can be used to install tools from the [Anaconda Cloud
+conda can be used to install tools from the [Anaconda
 repository](https://repo.anaconda.com/).
 
-Anaconda cloud (anaconda.org) contains public and private repositories for
+Anaconda.org contains public and private repositories for
 packages. These repositories are known as channels (discussed below).
 
 :::{admonition} A brief history of conda's evolution
@@ -95,12 +95,12 @@ channels. The conda package manager can install packages from different channels
 There are several core public channels that most people use to install
 packages using conda, including:
 
-- **defaults:** this is a channel managed by Anaconda. It is the version of the Python packages that you will install if you install the Anaconda Distribution. Anaconda decides what packages live on the default channel.
+- **defaults:** this is a channel managed by Anaconda. It is the version of the Python packages that you will install if you install the Anaconda Distribution. Anaconda (the company) decides what packages live on the `defaults` channel.
 - [**conda-forge:**](https://anaconda.org/conda-forge) this is a community-driven channel that focuses on scientific packages. This channel is ideal for tools that support geospatial data. Anyone can publish a package to this channel.
 - [**bioconda**](https://anaconda.org/bioconda): this channel focuses on biomedical tools.
 
 **conda-forge** emerged as many of the scientific packages did not
-exist in the default Anaconda cloud channel.
+exist in the `defaults` Anaconda channel.
 
 :::{figure-md} pypi-conda-channels
 
diff --git a/package-structure-code/python-package-structure.md b/package-structure-code/python-package-structure.md
@@ -147,7 +147,7 @@ If your package tests require data, we suggest that you do NOT include that
 data within your package structure. We will discuss this in more detail in a
 tutorial. Include data in your package structure increases the size of your
 distribution files. This places a maintenance toll on repositories like PyPI and
-anaconda cloud that have to deal with thousands of package uploads.
+Anaconda.org that have to deal with thousands of package uploads.
 ```
 
 ## About the flat Python package layout
diff --git a/tutorials/get-to-know-hatch.md b/tutorials/get-to-know-hatch.md
@@ -44,6 +44,13 @@ To open the config file in your file browser, run the following command in your
 
 This will open up a directory window that will allow you to double click on the file and open it in your favorite text editor.
 
+You can also retrieve the location of the Hatch config file by running the following command in your shell:
+
+```bash
+hatch config find
+# hatch config --help will show you all the options for config.
+```
+
 ### Step 2 - update your email and name
 
 Once the file is open, update the [template] table of the `config.toml` file with your name and email. This information will be used in any `pyproject.toml` metadata files that you create using Hatch.
diff --git a/tutorials/intro.md b/tutorials/intro.md
@@ -29,7 +29,6 @@ understanding the steps involved in creating a Python package.
 :caption: Python Packaging Tutorial Setup
 
 Get to know Hatch <get-to-know-hatch>
-Migrate setup.py to a pyproject.toml using Hatch <setup-py-to-pyproject-toml>
 :::
 
 :::{toctree}
@@ -51,6 +50,13 @@ Add a license & code of conduct <add-license-coc>
 Update metadata in pyproject.toml <pyproject-toml>
 :::
 
+:::{toctree}
+:hidden:
+:caption: Hatch for Existing Packages
+
+Migrate setup.py to a pyproject.toml using Hatch <setup-py-to-pyproject-toml>
+:::
+
 :::{admonition} Learning Objectives
 
 This lesson introduces you to the basic components of a Python package.
diff --git a/tutorials/publish-conda-forge.md b/tutorials/publish-conda-forge.md
@@ -38,9 +38,9 @@ Once you have published both package distributions (the source distribution and
 ## What is conda-forge?
 
 conda is an open source package and environment management tool that
-can be used to install tools from the different channels within the Anaconda Cloud repository.
+can be used to install tools from the different channels on Anaconda.org.
 
-You can think about a channel as a specific location where a group of packages are stored and can be installed from using a command such as `conda install packagename`. In the case of the Anaconda cloud channels, some of these channels such as the default channel, is managed by Anaconda (the company). Only Anaconda can decide what packages are available in the default channel. However, the conda-forge (and bioconda) channel are community-managed channels.
+You can think about a channel as a specific location where a group of packages are stored and can be installed from using a command such as `conda install packagename`. In the case of conda channels, some of these channels such as the `defaults` channel, is managed by Anaconda (the company). Only Anaconda can decide what packages are available in the `defaults` channel. However, the conda-forge (and bioconda) channel are community-managed channels.
 Anyone can submit a package to these channels however they must pass a technical review in the [staged-recipes GitHub repository](https://github.com/conda-forge/staged-recipes) to be published.
 
 [Learn more about conda channels here.](#about-conda)
diff --git a/tutorials/publish-pypi.md b/tutorials/publish-pypi.md
@@ -160,9 +160,9 @@ To build your package run `hatch build`:
 ```bash
 ➜ hatch build
 ──────────────── sdist ─────────────────
-dist/pyospackage-0.1.0.tar.gz
+dist/pyospackage-0.1.tar.gz
 ──────────────── wheel ─────────────────
-dist/pyospackage-0.1.0-py3-none-any.whl
+dist/pyospackage-0.1-py3-none-any.whl
 
 ```
 
@@ -178,9 +178,9 @@ your package to conda-forge](publish-conda-forge). You will learn about this in
 :::{todo}
 ➜ hatch build
 ────────────────────────────────────── sdist ──────────────────────────────────────
-dist/pyospackage-0.1.0.tar.gz
+dist/pyospackage-0.1.tar.gz
 ────────────────────────────────────── wheel ──────────────────────────────────────
-dist/pyospackage-0.1.0-py3-none-any.whl
+dist/pyospackage-0.1-py3-none-any.whl
 :::
 
 ### <i class="fa-solid fa-wand-magic-sparkles"></i> Congratulations - you've created your Python package distribution files <i class="fa-solid fa-wand-magic-sparkles"></i>
@@ -280,8 +280,8 @@ TestPyPI.
 ❯ hatch publish -r test
 Enter your username: __token__
 Enter your credentials: <paste-your-token-value-here>
-dist/pyospackage-0.1.0-py3-none-any.whl ... already exists
-dist/pyospackage-0.1.0.tar.gz ... already exists
+dist/pyospackage-0.1-py3-none-any.whl ... already exists
+dist/pyospackage-0.1.tar.gz ... already exists
 
 ```
 
diff --git a/tutorials/pyproject-toml.md b/tutorials/pyproject-toml.md
@@ -688,7 +688,7 @@ You are now ready to publish a new version of your Python package to (test) PyPI
 Try to republish now.
 
 First, update the version of your package in your pyproject toml file. Below version is updated from
-`0.1.0` to `0.1.1`.
+`0.1` to `0.1.1`.
 
 ```TOML
 [build-system]
