DESCRIPTION.rst 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  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://bitbucket.org/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.29.0
  38. ======
  39. - Fix compression type of files in archive (Issue #155, Pull Request #62,
  40. thanks Xavier Fernandez)
  41. 0.28.0
  42. ======
  43. - Fix file modes in archive (Issue #154)
  44. 0.27.0
  45. ======
  46. - Support forcing a platform tag using `--plat-name` on pure-Python wheels, as
  47. well as nonstandard platform tags on non-pure wheels (Pull Request #60, Issue
  48. #144, thanks Andrés Díaz)
  49. - Add SOABI tags to platform-specific wheels built for Python 2.X (Pull Request
  50. #55, Issue #63, Issue #101)
  51. - Support reproducible wheel files, wheels that can be rebuilt and will hash to
  52. the same values as previous builds (Pull Request #52, Issue #143, thanks
  53. Barry Warsaw)
  54. - Support for changes in keyring >= 8.0 (Pull Request #61, thanks Jason R.
  55. Coombs)
  56. - Use the file context manager when checking if dependency_links.txt is empty,
  57. fixes problems building wheels under PyPy on Windows (Issue #150, thanks
  58. Cosimo Lupo)
  59. - Don't attempt to (recursively) create a build directory ending with `..`
  60. (invalid on all platforms, but code was only executed on Windows) (Issue #91)
  61. - Added the PyPA Code of Conduct (Pull Request #56)
  62. 0.26.0
  63. ======
  64. - Fix multiple entrypoint comparison failure on Python 3 (Issue #148)
  65. 0.25.0
  66. ======
  67. - Add Python 3.5 to tox configuration
  68. - Deterministic (sorted) metadata
  69. - Fix tagging for Python 3.5 compatibility
  70. - Support py2-none-'arch' and py3-none-'arch' tags
  71. - Treat data-only wheels as pure
  72. - Write to temporary file and rename when using wheel install --force
  73. 0.24.0
  74. ======
  75. - The python tag used for pure-python packages is now .pyN (major version
  76. only). This change actually occurred in 0.23.0 when the --python-tag
  77. option was added, but was not explicitly mentioned in the changelog then.
  78. - wininst2wheel and egg2wheel removed. Use "wheel convert [archive]"
  79. instead.
  80. - Wheel now supports setuptools style conditional requirements via the
  81. extras_require={} syntax. Separate 'extra' names from conditions using
  82. the : character. Wheel's own setup.py does this. (The empty-string
  83. extra is the same as install_requires.) These conditional requirements
  84. should work the same whether the package is installed by wheel or
  85. by setup.py.
  86. 0.23.0
  87. ======
  88. - Compatibility tag flags added to the bdist_wheel command
  89. - sdist should include files necessary for tests
  90. - 'wheel convert' can now also convert unpacked eggs to wheel
  91. - Rename pydist.json to metadata.json to avoid stepping on the PEP
  92. - The --skip-scripts option has been removed, and not generating scripts is now
  93. the default. The option was a temporary approach until installers could
  94. generate scripts themselves. That is now the case with pip 1.5 and later.
  95. Note that using pip 1.4 to install a wheel without scripts will leave the
  96. installation without entry-point wrappers. The "wheel install-scripts"
  97. command can be used to generate the scripts in such cases.
  98. - Thank you contributors
  99. 0.22.0
  100. ======
  101. - Include entry_points.txt, scripts a.k.a. commands, in experimental
  102. pydist.json
  103. - Improved test_requires parsing
  104. - Python 2.6 fixes, "wheel version" command courtesy pombredanne
  105. 0.21.0
  106. ======
  107. - Pregenerated scripts are the default again.
  108. - "setup.py bdist_wheel --skip-scripts" turns them off.
  109. - setuptools is no longer a listed requirement for the 'wheel'
  110. package. It is of course still required in order for bdist_wheel
  111. to work.
  112. - "python -m wheel" avoids importing pkg_resources until it's necessary.
  113. 0.20.0
  114. ======
  115. - No longer include console_scripts in wheels. Ordinary scripts (shell files,
  116. standalone Python files) are included as usual.
  117. - Include new command "python -m wheel install-scripts [distribution
  118. [distribution ...]]" to install the console_scripts (setuptools-style
  119. scripts using pkg_resources) for a distribution.
  120. 0.19.0
  121. ======
  122. - pymeta.json becomes pydist.json
  123. 0.18.0
  124. ======
  125. - Python 3 Unicode improvements
  126. 0.17.0
  127. ======
  128. - Support latest PEP-426 "pymeta.json" (json-format metadata)
  129. 0.16.0
  130. ======
  131. - Python 2.6 compatibility bugfix (thanks John McFarlane)
  132. - Non-prerelease version number
  133. 1.0.0a2
  134. =======
  135. - Bugfix for C-extension tags for CPython 3.3 (using SOABI)
  136. 1.0.0a1
  137. =======
  138. - Bugfix for bdist_wininst converter "wheel convert"
  139. - Bugfix for dists where "is pure" is None instead of True or False
  140. 1.0.0a0
  141. =======
  142. - Update for version 1.0 of Wheel (PEP accepted).
  143. - Python 3 fix for moving Unicode Description to metadata body
  144. - Include rudimentary API documentation in Sphinx (thanks Kevin Horn)
  145. 0.15.0
  146. ======
  147. - Various improvements
  148. 0.14.0
  149. ======
  150. - Changed the signature format to better comply with the current JWS spec.
  151. Breaks all existing signatures.
  152. - Include ``wheel unsign`` command to remove RECORD.jws from an archive.
  153. - Put the description in the newly allowed payload section of PKG-INFO
  154. (METADATA) files.
  155. 0.13.0
  156. ======
  157. - Use distutils instead of sysconfig to get installation paths; can install
  158. headers.
  159. - Improve WheelFile() sort.
  160. - Allow bootstrap installs without any pkg_resources.
  161. 0.12.0
  162. ======
  163. - Unit test for wheel.tool.install
  164. 0.11.0
  165. ======
  166. - API cleanup
  167. 0.10.3
  168. ======
  169. - Scripts fixer fix
  170. 0.10.2
  171. ======
  172. - Fix keygen
  173. 0.10.1
  174. ======
  175. - Preserve attributes on install.
  176. 0.10.0
  177. ======
  178. - Include a copy of pkg_resources. Wheel can now install into a virtualenv
  179. that does not have distribute (though most packages still require
  180. pkg_resources to actually work; wheel install distribute)
  181. - Define a new setup.cfg section [wheel]. universal=1 will
  182. apply the py2.py3-none-any tag for pure python wheels.
  183. 0.9.7
  184. =====
  185. - Only import dirspec when needed. dirspec is only needed to find the
  186. configuration for keygen/signing operations.
  187. 0.9.6
  188. =====
  189. - requires-dist from setup.cfg overwrites any requirements from setup.py
  190. Care must be taken that the requirements are the same in both cases,
  191. or just always install from wheel.
  192. - drop dirspec requirement on win32
  193. - improved command line utility, adds 'wheel convert [egg or wininst]' to
  194. convert legacy binary formats to wheel
  195. 0.9.5
  196. =====
  197. - Wheel's own wheel file can be executed by Python, and can install itself:
  198. ``python wheel-0.9.5-py27-none-any/wheel install ...``
  199. - Use argparse; basic ``wheel install`` command should run with only stdlib
  200. dependencies.
  201. - Allow requires_dist in setup.cfg's [metadata] section. In addition to
  202. dependencies in setup.py, but will only be interpreted when installing
  203. from wheel, not from sdist. Can be qualified with environment markers.
  204. 0.9.4
  205. =====
  206. - Fix wheel.signatures in sdist
  207. 0.9.3
  208. =====
  209. - Integrated digital signatures support without C extensions.
  210. - Integrated "wheel install" command (single package, no dependency
  211. resolution) including compatibility check.
  212. - Support Python 3.3
  213. - Use Metadata 1.3 (PEP 426)
  214. 0.9.2
  215. =====
  216. - Automatic signing if WHEEL_TOOL points to the wheel binary
  217. - Even more Python 3 fixes
  218. 0.9.1
  219. =====
  220. - 'wheel sign' uses the keys generated by 'wheel keygen' (instead of generating
  221. a new key at random each time)
  222. - Python 2/3 encoding/decoding fixes
  223. - Run tests on Python 2.6 (without signature verification)
  224. 0.9
  225. ===
  226. - Updated digital signatures scheme
  227. - Python 3 support for digital signatures
  228. - Always verify RECORD hashes on extract
  229. - "wheel" command line tool to sign, verify, unpack wheel files
  230. 0.8
  231. ===
  232. - none/any draft pep tags update
  233. - improved wininst2wheel script
  234. - doc changes and other improvements
  235. 0.7
  236. ===
  237. - sort .dist-info at end of wheel archive
  238. - Windows & Python 3 fixes from Paul Moore
  239. - pep8
  240. - scripts to convert wininst & egg to wheel
  241. 0.6
  242. ===
  243. - require distribute >= 0.6.28
  244. - stop using verlib
  245. 0.5
  246. ===
  247. - working pretty well
  248. 0.4.2
  249. =====
  250. - hyphenated name fix
  251. 0.4
  252. ===
  253. - improve test coverage
  254. - improve Windows compatibility
  255. - include tox.ini courtesy of Marc Abramowitz
  256. - draft hmac sha-256 signing function
  257. 0.3
  258. ===
  259. - prototype egg2wheel conversion script
  260. 0.2
  261. ===
  262. - Python 3 compatibility
  263. 0.1
  264. ===
  265. - Initial version