Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details on native packaging requirements exposed by mobile platforms #27

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
eb2419a
Add details on native packaging requirements exposed by mobile platfo…
freakboy3742 Jan 9, 2023
8fef63e
Clarified the role/impact of cross-compilation on non-macOS platforms.
freakboy3742 Jan 10, 2023
d16035f
Grammar cleanup.
freakboy3742 Jan 10, 2023
84dbd5f
Add note about Windows platform support
freakboy3742 Jan 10, 2023
2a40f47
Moved a paragraph about the universal2 to current state.
freakboy3742 Jan 10, 2023
2563270
Clarified how Android deals with dependencies.
freakboy3742 Jan 10, 2023
b9b904c
Added an alternative approach for handling iOS multi-arch.
freakboy3742 Jan 10, 2023
45f748f
Modified comments to use common section structure, and include specif…
freakboy3742 Jan 16, 2023
373bb09
Apply suggestions from code review
freakboy3742 Jan 16, 2023
d8a2ca6
More updates stemming from review.
freakboy3742 Jan 16, 2023
f533395
Expand note about Linux support.
freakboy3742 Jan 17, 2023
8475360
Correct an it's typo.
freakboy3742 Jan 17, 2023
2886f2c
Add content to page on cross compilation
rgommers Feb 27, 2023
7556850
Resolve the last cross-compilation comment, on `pip --platform`
rgommers Mar 10, 2023
cb85652
Merge branch 'main' into mobile-details
rgommers Mar 10, 2023
49806e2
Put back link to "multiple architectures" page from cross compile page
rgommers Mar 10, 2023
ea1fb60
Remove the `cross_platform.md` file
rgommers Mar 10, 2023
d249af6
Fix some formatting and typo issues
rgommers Mar 10, 2023
50d8c26
Revisions to multi-architecture notes following review.
freakboy3742 Mar 20, 2023
a9776e0
Add foldout for pros and cons of `universal2` wheels
rgommers Mar 21, 2023
8d46e06
Add the 'for' arguments for universal2.
freakboy3742 Mar 21, 2023
5d06a56
Clarified 'end user' language; added note about merge problems.
freakboy3742 Mar 22, 2023
3e1fc05
Clarify the state of arm64 on github actions.
freakboy3742 Mar 22, 2023
74705d8
Add reference to pip issue about universal2 wheel installation.
freakboy3742 Mar 22, 2023
f46d2b0
Fixed typo.
freakboy3742 Mar 22, 2023
e1c278f
Removed subjective language.
freakboy3742 Mar 22, 2023
1a926eb
Apply textual/typo suggestions
rgommers Mar 22, 2023
7967383
Rephrase universal2 usage frequency/demand phrasing
rgommers Mar 22, 2023
1fb0ffb
Tone down the statement on "must provide thin wheels"
rgommers Mar 22, 2023
b44a322
Rephrase note on needed robustness improvements in delocate-fuse
rgommers Mar 22, 2023
dd93f1f
Add "first-class support for fusing thin wheels" as a potential solution
rgommers Mar 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 28 additions & 10 deletions docs/key-issues/multiple_architectures.md
Expand Up @@ -117,26 +117,44 @@ and ARM64 slices.
not provide them). There are some arguments for and against supporting the
format or even defaulting to it.

Arguments for (Russell to write):

- xxx
Arguments for:

- While users with a technical background are usually aware of the CPU
architecture of their machine, less technical end users are often
unaware of this detail (or of the significance of this detail). The
universal2 wheel format allows users to largely ignore this detail, as
all CPU architectures for the macOS platform are accomodated in a single
binary artefact.
- macOS has developed an ecosystem where end users expect that any macOS
binary will run on any macOS machine, regardless of CPU architecture.
As a result, when building macOS apps (`.dmg` downloadable installers
or similar formats, produced by tools such as
[py2app](https://py2app.readthedocs.io) or
[briefcase](https://beeware.org/project/projects/tools/briefcase/)),
the person building the project must be accommodate all possible CPU
rgommers marked this conversation as resolved.
Show resolved Hide resolved
architectures where the code *could* be executed.
- If binary wheels are only available in "thin" format, any issues with
merging those wheels into fat equivalents for distribution purposes are
deferred to the end user. This can be problematic as it may require
rgommers marked this conversation as resolved.
Show resolved Hide resolved
expert knowledge about the package being merged (such as optional
modules or header files that may not be present in both thin artefacts).
Universal2 artefacts captures this knowledge by requiring the project
maintainers to resolve any merging issues.
rgommers marked this conversation as resolved.
Show resolved Hide resolved

Arguments against:

- `universal2` wheels are never necessary for end users, they are only an
intermediate stage for workflows and tooling to build macOS apps (`.dmg`
downloadable installers or similar formats, produced by for example
[py2app](https://py2app.readthedocs.io) or
[briefcase](https://beeware.org/project/projects/tools/briefcase/)).
- `universal2` wheels are never necessary for end users installing into
a locally installed Python environment exclusively for their own use,
which is the default experience most users have with Python.
- The tradeoff between download size and disk space usage vs. the upside
for say a .dmg installer is bad - for a typical PyData stack it takes
rgommers marked this conversation as resolved.
Show resolved Hide resolved
hundreds of MBs per Python environment more than thin wheels, and users
are likely to have quite a few environments on their system at once.
Meaning that defaulting to `universal2` would use several GBs of disk
space more.

- Disk space on the base MacBook models is 128 GB, and up to half of that
can be taken up by the OS and system data itself. So a few GBs is
- Disk space on older MacBook Air models is 128 GB, and up to half of that
can be taken up by the OS and system data itself. So a few GBs can be
significant.
- Internet plans in many countries are not unlimited; almost doubling the
download size of wheels is a serious cost, and not desirable for any
Expand Down