You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

340 lines
10 KiB

7 years ago
  1. Wheel
  2. =====
  3. A built-package format for Python.
  4. A wheel is a ZIP-format archive with a specially formatted filename
  5. and the .whl extension. It is designed to contain all the files for a
  6. PEP 376 compatible install in a way that is very close to the on-disk
  7. format. Many packages will be properly installed with only the "Unpack"
  8. step (simply extracting the file onto sys.path), and the unpacked archive
  9. preserves enough information to "Spread" (copy data and scripts to their
  10. final locations) at any later time.
  11. The wheel project provides a `bdist_wheel` command for setuptools
  12. (requires setuptools >= 0.8.0). Wheel files can be installed with a
  13. newer `pip` from https://github.com/pypa/pip or with wheel's own command
  14. line utility.
  15. The wheel documentation is at http://wheel.rtfd.org/. The file format
  16. is documented in PEP 427 (http://www.python.org/dev/peps/pep-0427/).
  17. The reference implementation is at https://github.com/pypa/wheel
  18. Why not egg?
  19. ------------
  20. Python's egg format predates the packaging related standards we have
  21. today, the most important being PEP 376 "Database of Installed Python
  22. Distributions" which specifies the .dist-info directory (instead of
  23. .egg-info) and PEP 426 "Metadata for Python Software Packages 2.0"
  24. which specifies how to express dependencies (instead of requires.txt
  25. in .egg-info).
  26. Wheel implements these things. It also provides a richer file naming
  27. convention that communicates the Python implementation and ABI as well
  28. as simply the language version used in a particular package.
  29. Unlike .egg, wheel will be a fully-documented standard at the binary
  30. level that is truly easy to install even if you do not want to use the
  31. reference implementation.
  32. Code of Conduct
  33. ---------------
  34. Everyone interacting in the wheel project's codebases, issue trackers, chat
  35. rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
  36. .. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
  37. 0.30.0
  38. ======
  39. - Added py-limited-api {cp32|cp33|cp34|...} flag to produce cpNN.abi3.{arch}
  40. tags on CPython 3.
  41. - Documented the ``license_file`` metadata key
  42. - Improved Python, abi tagging for `wheel convert`. Thanks Ales Erjavec.
  43. - Fixed `>` being prepended to lines starting with "From" in the long description
  44. - Added support for specifying a build number (as per PEP 427).
  45. Thanks Ian Cordasco.
  46. - Made the order of files in generated ZIP files deterministic.
  47. Thanks Matthias Bach.
  48. - Made the order of requirements in metadata deterministic. Thanks Chris Lamb.
  49. - Fixed `wheel install` clobbering existing files
  50. - Improved the error message when trying to verify an unsigned wheel file
  51. - Removed support for Python 2.6, 3.2 and 3.3.
  52. 0.29.0
  53. ======
  54. - Fix compression type of files in archive (Issue #155, Pull Request #62,
  55. thanks Xavier Fernandez)
  56. 0.28.0
  57. ======
  58. - Fix file modes in archive (Issue #154)
  59. 0.27.0
  60. ======
  61. - Support forcing a platform tag using `--plat-name` on pure-Python wheels, as
  62. well as nonstandard platform tags on non-pure wheels (Pull Request #60, Issue
  63. #144, thanks Andrés Díaz)
  64. - Add SOABI tags to platform-specific wheels built for Python 2.X (Pull Request
  65. #55, Issue #63, Issue #101)
  66. - Support reproducible wheel files, wheels that can be rebuilt and will hash to
  67. the same values as previous builds (Pull Request #52, Issue #143, thanks
  68. Barry Warsaw)
  69. - Support for changes in keyring >= 8.0 (Pull Request #61, thanks Jason R.
  70. Coombs)
  71. - Use the file context manager when checking if dependency_links.txt is empty,
  72. fixes problems building wheels under PyPy on Windows (Issue #150, thanks
  73. Cosimo Lupo)
  74. - Don't attempt to (recursively) create a build directory ending with `..`
  75. (invalid on all platforms, but code was only executed on Windows) (Issue #91)
  76. - Added the PyPA Code of Conduct (Pull Request #56)
  77. 0.26.0
  78. ======
  79. - Fix multiple entrypoint comparison failure on Python 3 (Issue #148)
  80. 0.25.0
  81. ======
  82. - Add Python 3.5 to tox configuration
  83. - Deterministic (sorted) metadata
  84. - Fix tagging for Python 3.5 compatibility
  85. - Support py2-none-'arch' and py3-none-'arch' tags
  86. - Treat data-only wheels as pure
  87. - Write to temporary file and rename when using wheel install --force
  88. 0.24.0
  89. ======
  90. - The python tag used for pure-python packages is now .pyN (major version
  91. only). This change actually occurred in 0.23.0 when the --python-tag
  92. option was added, but was not explicitly mentioned in the changelog then.
  93. - wininst2wheel and egg2wheel removed. Use "wheel convert [archive]"
  94. instead.
  95. - Wheel now supports setuptools style conditional requirements via the
  96. extras_require={} syntax. Separate 'extra' names from conditions using
  97. the : character. Wheel's own setup.py does this. (The empty-string
  98. extra is the same as install_requires.) These conditional requirements
  99. should work the same whether the package is installed by wheel or
  100. by setup.py.
  101. 0.23.0
  102. ======
  103. - Compatibility tag flags added to the bdist_wheel command
  104. - sdist should include files necessary for tests
  105. - 'wheel convert' can now also convert unpacked eggs to wheel
  106. - Rename pydist.json to metadata.json to avoid stepping on the PEP
  107. - The --skip-scripts option has been removed, and not generating scripts is now
  108. the default. The option was a temporary approach until installers could
  109. generate scripts themselves. That is now the case with pip 1.5 and later.
  110. Note that using pip 1.4 to install a wheel without scripts will leave the
  111. installation without entry-point wrappers. The "wheel install-scripts"
  112. command can be used to generate the scripts in such cases.
  113. - Thank you contributors
  114. 0.22.0
  115. ======
  116. - Include entry_points.txt, scripts a.k.a. commands, in experimental
  117. pydist.json
  118. - Improved test_requires parsing
  119. - Python 2.6 fixes, "wheel version" command courtesy pombredanne
  120. 0.21.0
  121. ======
  122. - Pregenerated scripts are the default again.
  123. - "setup.py bdist_wheel --skip-scripts" turns them off.
  124. - setuptools is no longer a listed requirement for the 'wheel'
  125. package. It is of course still required in order for bdist_wheel
  126. to work.
  127. - "python -m wheel" avoids importing pkg_resources until it's necessary.
  128. 0.20.0
  129. ======
  130. - No longer include console_scripts in wheels. Ordinary scripts (shell files,
  131. standalone Python files) are included as usual.
  132. - Include new command "python -m wheel install-scripts [distribution
  133. [distribution ...]]" to install the console_scripts (setuptools-style
  134. scripts using pkg_resources) for a distribution.
  135. 0.19.0
  136. ======
  137. - pymeta.json becomes pydist.json
  138. 0.18.0
  139. ======
  140. - Python 3 Unicode improvements
  141. 0.17.0
  142. ======
  143. - Support latest PEP-426 "pymeta.json" (json-format metadata)
  144. 0.16.0
  145. ======
  146. - Python 2.6 compatibility bugfix (thanks John McFarlane)
  147. - Non-prerelease version number
  148. 1.0.0a2
  149. =======
  150. - Bugfix for C-extension tags for CPython 3.3 (using SOABI)
  151. 1.0.0a1
  152. =======
  153. - Bugfix for bdist_wininst converter "wheel convert"
  154. - Bugfix for dists where "is pure" is None instead of True or False
  155. 1.0.0a0
  156. =======
  157. - Update for version 1.0 of Wheel (PEP accepted).
  158. - Python 3 fix for moving Unicode Description to metadata body
  159. - Include rudimentary API documentation in Sphinx (thanks Kevin Horn)
  160. 0.15.0
  161. ======
  162. - Various improvements
  163. 0.14.0
  164. ======
  165. - Changed the signature format to better comply with the current JWS spec.
  166. Breaks all existing signatures.
  167. - Include ``wheel unsign`` command to remove RECORD.jws from an archive.
  168. - Put the description in the newly allowed payload section of PKG-INFO
  169. (METADATA) files.
  170. 0.13.0
  171. ======
  172. - Use distutils instead of sysconfig to get installation paths; can install
  173. headers.
  174. - Improve WheelFile() sort.
  175. - Allow bootstrap installs without any pkg_resources.
  176. 0.12.0
  177. ======
  178. - Unit test for wheel.tool.install
  179. 0.11.0
  180. ======
  181. - API cleanup
  182. 0.10.3
  183. ======
  184. - Scripts fixer fix
  185. 0.10.2
  186. ======
  187. - Fix keygen
  188. 0.10.1
  189. ======
  190. - Preserve attributes on install.
  191. 0.10.0
  192. ======
  193. - Include a copy of pkg_resources. Wheel can now install into a virtualenv
  194. that does not have distribute (though most packages still require
  195. pkg_resources to actually work; wheel install distribute)
  196. - Define a new setup.cfg section [wheel]. universal=1 will
  197. apply the py2.py3-none-any tag for pure python wheels.
  198. 0.9.7
  199. =====
  200. - Only import dirspec when needed. dirspec is only needed to find the
  201. configuration for keygen/signing operations.
  202. 0.9.6
  203. =====
  204. - requires-dist from setup.cfg overwrites any requirements from setup.py
  205. Care must be taken that the requirements are the same in both cases,
  206. or just always install from wheel.
  207. - drop dirspec requirement on win32
  208. - improved command line utility, adds 'wheel convert [egg or wininst]' to
  209. convert legacy binary formats to wheel
  210. 0.9.5
  211. =====
  212. - Wheel's own wheel file can be executed by Python, and can install itself:
  213. ``python wheel-0.9.5-py27-none-any/wheel install ...``
  214. - Use argparse; basic ``wheel install`` command should run with only stdlib
  215. dependencies.
  216. - Allow requires_dist in setup.cfg's [metadata] section. In addition to
  217. dependencies in setup.py, but will only be interpreted when installing
  218. from wheel, not from sdist. Can be qualified with environment markers.
  219. 0.9.4
  220. =====
  221. - Fix wheel.signatures in sdist
  222. 0.9.3
  223. =====
  224. - Integrated digital signatures support without C extensions.
  225. - Integrated "wheel install" command (single package, no dependency
  226. resolution) including compatibility check.
  227. - Support Python 3.3
  228. - Use Metadata 1.3 (PEP 426)
  229. 0.9.2
  230. =====
  231. - Automatic signing if WHEEL_TOOL points to the wheel binary
  232. - Even more Python 3 fixes
  233. 0.9.1
  234. =====
  235. - 'wheel sign' uses the keys generated by 'wheel keygen' (instead of generating
  236. a new key at random each time)
  237. - Python 2/3 encoding/decoding fixes
  238. - Run tests on Python 2.6 (without signature verification)
  239. 0.9
  240. ===
  241. - Updated digital signatures scheme
  242. - Python 3 support for digital signatures
  243. - Always verify RECORD hashes on extract
  244. - "wheel" command line tool to sign, verify, unpack wheel files
  245. 0.8
  246. ===
  247. - none/any draft pep tags update
  248. - improved wininst2wheel script
  249. - doc changes and other improvements
  250. 0.7
  251. ===
  252. - sort .dist-info at end of wheel archive
  253. - Windows & Python 3 fixes from Paul Moore
  254. - pep8
  255. - scripts to convert wininst & egg to wheel
  256. 0.6
  257. ===
  258. - require distribute >= 0.6.28
  259. - stop using verlib
  260. 0.5
  261. ===
  262. - working pretty well
  263. 0.4.2
  264. =====
  265. - hyphenated name fix
  266. 0.4
  267. ===
  268. - improve test coverage
  269. - improve Windows compatibility
  270. - include tox.ini courtesy of Marc Abramowitz
  271. - draft hmac sha-256 signing function
  272. 0.3
  273. ===
  274. - prototype egg2wheel conversion script
  275. 0.2
  276. ===
  277. - Python 3 compatibility
  278. 0.1
  279. ===
  280. - Initial version

Powered by TurnKey Linux.