diff options
| author | Daniel Holth <dholth@fastmail.fm> | 2012-07-12 00:48:16 -0400 |
|---|---|---|
| committer | Daniel Holth <dholth@fastmail.fm> | 2012-07-12 00:48:16 -0400 |
| commit | e9cb825daa49af13079774c599571e11866b06fd (patch) | |
| tree | ec92ba6e391296e45e7c8d4d08b6cfb7e3eb21a2 | |
| parent | 567b3344390cd66697ee9aad1083bcab55010f35 (diff) | |
| download | wheel-e9cb825daa49af13079774c599571e11866b06fd.tar.gz | |
add 'why not egg' to sphinx docs
| -rw-r--r-- | docs/index.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index 0097356..147913f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,23 @@ for setuptools (requiring a patched distribute from https://bitbucket.org/dholth/distribute). Wheel files can be installed with a patched `pip` from https://github.com/dholth/pip. +Why not egg? +------------ + +Python's egg format predates the packging related standards we have today, +the most important being PEP 376 "Database of Installed Python Distributions" +which specifies the .dist-info directory (instead of .egg-info) and PEP 345 +"Metadata for Python Software Packages 1.2" which specifies how to express +dependencies (instead of requires.txt in .egg-info). + +Wheel implements these things. It also provides a richer file naming +convention that communicates the Python implementation and ABI as well as +simply the language version used in a particular package. + +Unlike .egg, wheel will be a fully-documented standard at the binary level +that is truly easy to install even if you do not want to use the reference +implementation. + Usage ----- |