Skip to content

Commit b5cb005

Browse files
committed
Fix: more review edits
1 parent 22db6c3 commit b5cb005

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

package-structure-code/intro.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ src layout, flat layout and where should tests folders live? No matter what your
2828

2929
✨ 2. Learn about building your package ✨
3030
^^^
31-
Building a Python package refers to the process of placing your package code
32-
metadata (and tests) into a specific format that PyPI can read and that
33-
your users can install. Learn more about building a Python package here.
31+
Building a Python package is a great way to share your code with scientists to support open science workflow. The act of "building" refers to the process of placing your package code and
32+
metadata into a format that can be published on PyPI. Once published on PyPI, your users can easily install it locally using pip. Learn more about building a Python package here.
3433
:::
3534

3635
:::{grid-item-card}
@@ -155,7 +154,7 @@ if you are looking for pyOpenSci's Python package review requirements!
155154
Intro <self>
156155
157156
Python package structure <python-package-structure>
158-
pyproject.toml Package Metadata <pyproject-toml-python-package-metada>
157+
pyproject.toml Package Metadata <pyproject-toml-python-package-metadata>
159158
Build Your Package <python-package-distribution-files-sdist-wheel>
160159
Package Build Tools <python-package-build-tools>
161160
Complex Builds <complex-python-package-builds>

package-structure-code/python-package-distribution-files-sdist-wheel.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Learn about Building a Python Package
22

33
:::{figure-md} build-workflow
4-
<img src="/images/python-package-development-process.png" alt="Alt tag to be added when image is final" width="700px">
4+
<img src="../images/python-package-development-process.png" alt="Alt tag to be added when image is final" width="700px">
55

6-
You need to build your Python package in order to publish it to PyPI or Conda. For PyPI, the build process essentially organizes your code and metadata into a distribution format that PyPI can read and provide to potential users.
6+
You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users.
77
:::
88

99
## What is building a Python package?
@@ -56,7 +56,7 @@ You could in theory create your own scripts to organize your code the way PyPI w
5656
There are a suite of packaging tools that can either help you with
5757
the entire packaging process or just one step of the process. For instance
5858
setuptools is a commonly used build back end that can be used to create your
59-
SDist and wheel. Whereas tools like Hatch, PDM, Poetry and flit help with other
59+
sdist and wheel. Whereas tools like Hatch, PDM, Poetry and flit help with other
6060
parts of the packaging process.
6161
6262
While this can cause some confusion and
@@ -65,20 +65,20 @@ the same distribution output (with minor differences that most users may not
6565
care about). Learn more about those tools on this page.
6666
```
6767

68-
Below, you will learn about the two distribution files that PyPI expects you to publish: SDist and Wheel. You will learn about
68+
Below, you will learn about the two distribution files that PyPI expects you to publish: sdist and wheel. You will learn about
6969
their structure and what files belong in each.
7070

7171
There are two core distribution files
7272
that you need to create to publish your Python package to
7373
PyPI source distribution (often called an sdist) and wheel. The sdist contains the raw source
74-
code for your package. The Wheel (.whl) contains the built / compiled files
74+
code for your package. The wheel (.whl) contains the built / compiled files
7575
that can be directly installed onto anyones' computer.
7676

7777
Learn more about both distributions below.
7878

7979
```{note}
8080
If your package is a pure python package with no additional
81-
build / compilation steps then the sdist and Wheel distributions will have
81+
build / compilation steps then the sdist and wheel distributions will have
8282
similar content. However if your package has extensions in other languages
8383
or is more complex in its build, the two distributions will be very different.
8484
@@ -150,13 +150,13 @@ stravalib-1.1.0.post2-SDist.tar.gz file contents
150150
151151
```
152152

153-
```{admonition} GitHub archive vs SDist
153+
```{admonition} GitHub archive vs sdist
154154
:class: tip
155155
When you make a release on GitHub, it creates a `git archive` that contains all
156156
of the files in your GitHub repository. While these files are similar to an
157-
SDist, these two archives are not the same. The SDist contains a few other
157+
sdist, these two archives are not the same. The sdist contains a few other
158158
items including a metadata directory and if you use `setuptools_scm` or `hatch_vcs`
159-
the SDist may also contain a file that stores the version.
159+
the sdist may also contain a file that stores the version.
160160
```
161161

162162
### Wheel (.whl files):

0 commit comments

Comments
 (0)