Skip to content

Commit 6007641

Browse files
committed
Fix: several minor edits
1 parent 1d055bf commit 6007641

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

tutorials/publish-pypi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
:::{todo}
44
* emphasize that we recommended the trusted publisher GitHub action for most maintainers
5-
* Make sure they add /dist to their .gitignore file. We have not discussed github workflows anywhere yet. Where does that fit?
5+
* Make sure they add /dist to their .gitignore file. We have not discussed GitHub workflows anywhere yet. Where does that fit?
66
* https://hatch.pypa.io/latest/intro/#existing-project <- hatch will migrate from setup.py for you - if we go with hatch then we may want to add this to the installable code lesson
77
* Should we install hatch with pipx?
88

@@ -33,7 +33,7 @@ In this lesson you will learn how to:
3333
You will do all of your development work in this lesson using [Hatch](https://hatch.pypa.io/latest/).
3434

3535
Once your package is on PyPI you can publish it to the conda-forge channel of conda
36-
using [grayskull](https://conda.github.io/grayskull/).
36+
using [Grayskull](https://conda.github.io/grayskull/).
3737

3838
You will learn how to publish to conda-forge in a future lesson.
3939

@@ -72,7 +72,7 @@ you need to do to publish your Python package:
7272
to PyPI. You need to:
7373

7474
1. **Create a package development environment**
75-
1. [**Build your package using `hatch build`**](../package-structure-code/python-package-distribution-files-sdist-wheel). Building a package is the process of turning your code into 2 types of distribution files: sdist and wheel. The wheel distribution file is particularly important for users who will `pip install` your package.
75+
1. [**Build your package using `hatch build`**](../package-structure-code/python-package-distribution-files-sdist-wheel). Building a package is the process of turning your code into two types of distribution files: sdist and wheel. The wheel distribution file is particularly important for users who will `pip install` your package.
7676
1. **Create an account on (test) PyPI**: You will need to create a PyPI account and associated token which provides permissions for you to upload your package.
7777
1. **Publish to PyPI using `hatch publish`**
7878

@@ -169,7 +169,7 @@ Hatch will:
169169
Once you have your development environment setup, you are ready to build your package using Hatch. Remember that building is the process of turning your Python package file structure into two distribution files:
170170

171171
1. The [wheel distribution](#python-wheel) is a pre-built version of your package. It useful for users as it can be directly installed using a tool such as `pip`. This file has the extension `.whl`.
172-
2. The [source distribution](#python-source-distribution) is the files that make up your package in an unbuilt format. This file will have the extension `.tar.gz`.
172+
2. The [source distribution](#python-source-distribution) contains the files that make up your package in an unbuilt format. This file will have the extension `.tar.gz`.
173173

174174
You will use Hatch as a **Front end** tool that builds
175175
your package's sdist and wheel using the [hatchling](https://hatch.pypa.io/latest/) build back-end.
@@ -224,7 +224,7 @@ If you have a package that you are confident belongs on PyPI, all of the steps b
224224
1. [Open up a web browser and go to the test PyPI website](https://test.pypi.org/).
225225
2. [Create an account](https://test.pypi.org/account/register/) if you don't already have one. Be sure to store your password in a safe place!
226226
3. Once you have an account setup, login to it.
227-
4. Search on [https://test.pypi.org/](https://test.pypi.org/) (or pypi.org) to ensure that the package name that you have selected doesn't already exist. If you are using our test pyosPackage, then we suggest that you add your name or GitHub username to the end of the package name to ensure it's unique.
227+
4. Search on [https://test.pypi.org/](https://test.pypi.org/) to ensure that the package name that you have selected doesn't already exist. If you are using our test pyosPackage, then we suggest that you add your name or GitHub username to the end of the package name to ensure it's unique.
228228

229229
Example: `pyosPackage_yourNameHere`.
230230

@@ -316,7 +316,7 @@ test PYPI. You can find the installation instructions on the test PyPI
316316
landing page for your newly uploaded package.
317317

318318
:::{figure-md} testpypi-landing-page
319-
<img src="../images/tutorials/test-pypi-package.png" alt="A screenshot of the test PyPI page for pyosPackage. It says pyosPackage 0.1.0 at the top with the pip install instructions below. The landing page of the package has information from the package's readme file. " width="700px">
319+
<img src="../images/tutorials/test-pypi-package.png" alt="A screenshot of the test PyPI page for pyosPackage. It says pyosPackage 0.1.0 at the top with the pip install instructions below. The landing page of the package has information from the package's README file. " width="700px">
320320

321321
This is an example landing page for the pyosPackage that was just uploaded. Notice at the top of the page there is instruction for how to install the package from test PyPI. You can simply copy that code and use it to install your package from testPyPi locally.
322322
:::

0 commit comments

Comments
 (0)