Axle is Python wheel enhancement library
Project description
Wheel Axle - Python Wheel enhancement library
Problem
- Python wheel does not support symlinks.
- Python wheel does not support overwriting in a convenient way:
- whether the distribution is pure-Python
- distribution ABI tag
- extend Python tag override capability
Solution
WARNING: THIS IS EXPERIMENTAL BETA SOFTWARE. THERE ARE NO WARRANTIES OF ANY KIND. USE AT YOUR OWN RISK. ADDITIONAL INCLUDED DISCLAIMERS ALSO APPLY.
Wheel-Axle (axle
, bdist_axle
) is a drop-in replacement/augmentation utility for wheel
(bdist_wheel
)
that extends and builds spec-compliant wheels.
During the build, axle
is able to capture and record in the Python wheel the symlinks in the following
schema paths (locations):
- purelib
- platlib
- scripts
- headers
- data
Additionally, Axle
is able to customize the Python wheel tags via additional command line options.
While the generated Python wheel is fully spec-compliant, additional symlink functionality is not possible without its
companion library Wheel Axle Runtime. Thus, every Python wheel
generated by the bdist_axle
automatically becomes dependent on wheel-axle-runtime
that provides
post-install logic required.
Implementation
The body of the library is as ugly and messy as distutils
/setuptools
are, and consists of, mainly, in
hacking/overwriting various setuptools
commands to detect, handle and record symlinks and their targets. Once that
problem is solved, the list of symlinks is recorded in the .dist-info/symlinks.txt
in the following CSV format:
- symlink name
- symlink target
- a boolean (0 or 1) flag indicating whether the target is a directory
NOTE: Symlinks may be relative, absolute and/or broken. Symlink targets are recorded verbatim (even when broken) and are NOT otherwise interpreted. THIS IS INTENTIONAL. Please see Wheel Axle Runtime Security Notice for additional information.
A special <distribution name and version>.pth
file is also added to the distribution. When the wheel is installed
this .pth
file triggers the post-install logic via
wheel-axle-runtime.
Usage
python setup.py bdist_wheel <arguments>
can be replaced with python setup.py bdist_axle <arguments>
. The replacement
is drop-in.
Additional functionality is available via the following options:
--python-tag Python implementation compatibility tag (default: 'py3')
--root-is-pure set to manually override whether the wheel is
pure (default: None)
--abi-tag set to override ABI tag (default: None)
Using --python-tag
, --root-is-pure
and --abi-tag
allows you to create wheels that carry platform-dependent data
while otherwise containing pure-Python libraries.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wheel_axle-0.0.8.dev20240209070956.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f59888d6adeceddf311c5804ff1ff909bd5e164547c343bef521cfe432828b2 |
|
MD5 | d37198e402d93bbd3a72b4c1370a3db3 |
|
BLAKE2b-256 | e71ba453affeab833c4a008f183cc12a3c8ddfd4c2eec5f43b862ee2ca141b8d |
Hashes for wheel_axle-0.0.8.dev20240209070956-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9b93818a7d26077673aa05e7809858bedd19d0fa86783e667102a6a3f955c31 |
|
MD5 | e6b73f8067b9ca841338c88a87ddf669 |
|
BLAKE2b-256 | 57ef2d51e5399c4f8e72ee93759a1ebdf39760bd288d5a1ab637ee57b0b714f1 |