Skip to content

Commit 36b4023

Browse files
committed
deploy: 4b45c5d
1 parent 1dabce2 commit 36b4023

28 files changed

+201
-152
lines changed

.doctrees/environment.pickle

1.99 KB
Binary file not shown.
3.31 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.

.doctrees/tests/index.doctree

505 Bytes
Binary file not shown.

.doctrees/tutorials/intro.doctree

855 Bytes
Binary file not shown.
98.3 KB
Loading
Binary file not shown.

_sources/package-structure-code/intro.md.txt

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1-
# Python package structure information
1+
# Python Package Structure
22

3-
This section provides guidance on your Python package's structure, code formats
4-
and style. It also reviews the various packaging tools that you can use to
5-
support building and publishing your package.
3+
This section provides guidance on your Python package's structure, code format,
4+
and style. It also reviews the various [packaging tools](python-package-build-tools) you can use to
5+
[build](python-package-distribution-files-sdist-wheel) and [publish](publish-python-package-pypi-conda) your Python package.
6+
7+
If you want end-to-end tutorials, check out our tutorial series that starts by introducing [what a Python package is](what-is-a-package).
68

79
If you are confused by Python packaging, you are not alone! The good news is
8-
there are some great modern packaging tools that ensure that you're following
9-
best practices. Here, we review tool features and suggest tools that might be
10-
best fitted for your workflow.
10+
that some great modern packaging tools ensure you follow
11+
best practices. Here, we review tool features and suggest tools you can use
12+
for your Python packaging workflow.
13+
14+
:::{button-link} /tutorials/intro
15+
:color: success
16+
:class: sd-rounded-pill float-left
17+
18+
Checkout our beginning-to-end create a Python package tutorials
19+
20+
:::
21+
22+
23+
:::{admonition} How this content is developed
24+
All of the content in this guide has been vetted by community members, including maintainers and developers of the core packaging tools.
25+
:::
26+
1127

1228
:::::{grid} 1 1 2 2
1329
:class-container: text-center

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Also note that we are not discussing conda build workflows in this section.
152152
```
153153

154154
(python-source-distribution)=
155-
## Source Distribution (sdist)
155+
## What is a source distribution (sdist)
156156

157157
**Source files** are the unbuilt files needed to build your
158158
package. These are the "raw / as-is" files that you store on GitHub or whatever
@@ -226,7 +226,7 @@ the sdist may also contain a file that stores the version.
226226
```
227227

228228
(python-wheel)=
229-
## Wheel (.whl files):
229+
## What is a Python wheel (whl):
230230

231231
A wheel file is a ZIP-format archive whose filename follows a specific format
232232
(below) and has the extension `.whl`. The `.whl` archive contains a specific

0 commit comments

Comments
 (0)