You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: package-structure-code/intro.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,8 @@ src layout, flat layout and where should tests folders live? No matter what your
28
28
29
29
✨ 2. Learn about building your package ✨
30
30
^^^
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.
34
33
:::
35
34
36
35
:::{grid-item-card}
@@ -155,7 +154,7 @@ if you are looking for pyOpenSci's Python package review requirements!
Copy file name to clipboardExpand all lines: package-structure-code/python-package-distribution-files-sdist-wheel.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Learn about Building a Python Package
2
2
3
3
:::{figure-md} build-workflow
4
-
<imgsrc="/images/python-package-development-process.png"alt="Alt tag to be added when image is final"width="700px">
4
+
<imgsrc="../images/python-package-development-process.png"alt="Alt tag to be added when image is final"width="700px">
5
5
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.
7
7
:::
8
8
9
9
## 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
56
56
There are a suite of packaging tools that can either help you with
57
57
the entire packaging process or just one step of the process. For instance
58
58
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
60
60
parts of the packaging process.
61
61
62
62
While this can cause some confusion and
@@ -65,20 +65,20 @@ the same distribution output (with minor differences that most users may not
65
65
care about). Learn more about those tools on this page.
66
66
```
67
67
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
69
69
their structure and what files belong in each.
70
70
71
71
There are two core distribution files
72
72
that you need to create to publish your Python package to
73
73
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
75
75
that can be directly installed onto anyones' computer.
76
76
77
77
Learn more about both distributions below.
78
78
79
79
```{note}
80
80
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
82
82
similar content. However if your package has extensions in other languages
83
83
or is more complex in its build, the two distributions will be very different.
0 commit comments