Skip to content

Commit

Permalink
Update file extensions for SDists and wheels
Browse files Browse the repository at this point in the history
A minor documentation fix, this section referred to the wheel as a `.tar.gz` file while it isn't – it is fairly known that it is a `.zip` file.

I added the correct file extension for the SDist in the point above it, just for the sake of clarity.
  • Loading branch information
agriyakhetarpal committed Jan 12, 2024
1 parent 57fc352 commit 09d78f7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/pages/guides/packaging_classic.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,15 +403,15 @@ Python packaging goes through a 3-stage procedure if you have the above
recommended `pyproject.toml` file. If you type `pip install .`, then

1. Source is processed to make an SDist (in a virtual environment mandated by
pyproject.toml).
pyproject.toml). This SDist bears a `.tar.gz` file format.
2. SDist is processed to make a wheel (same virtual environment).
3. The wheel is installed.

The wheel does _not_ contain `setup.*`, `pyproject.toml`, or other build code.
It simply is a `.tar.gz` file that is named `.whl` and has a simple mapping of
directories to installation paths and a generic metadata format. "Installing"
really is just copying files around, and pip also pre-compiles some bytecode for
you while doing so.
It simply is a `.zip` format archive with the `.whl` suffix and has a simple
mapping of directories to installation paths and a generic metadata format.
"Installing" really is just copying files around, and pip also pre-compiles some
bytecode for you while doing so.

If you don't have a `MANIFEST.in`, the "legacy" build procedure will skip the
SDist step, making it possible for a development build to work while a published
Expand Down

0 comments on commit 09d78f7

Please sign in to comment.