Lines Matching refs:egg

16 A "Python egg" is a logical structure embodying the release of a
19 encode a Python egg, and others can be developed. However, a key
27 1. ``.egg`` format: a directory or zipfile *containing* the project's
31 2. ``.egg-info`` format: a file or directory placed *adjacent* to the
40 The ``.egg`` format is well-suited to distribution and the easy
47 The ``.egg-info`` format, on the other hand, was created to support
53 ``sys.path`` to include each installed egg.
59 command refers to this type of egg installation as "single-version,
62 application by copying ``.egg`` files or directories to a target
63 location, but it cannot do this for ``.egg-info`` installs, because
65 egg -- there may be several eggs "scrambled" together in a single
66 installation location, and the ``.egg-info`` format does not currently
75 import layout, relative to the egg's "base location".
77 For the ``.egg`` format, the base location is the ``.egg`` itself. That
78 is, adding the ``.egg`` filename or directory name to ``sys.path``
81 For the ``.egg-info`` format, however, the base location is the
82 directory that *contains* the ``.egg-info``, and thus it is the
83 directory that must be added to ``sys.path`` to make the egg importable.
85 ``sys.path`` directory is sufficient to make it an "egg" if it has an
86 ``.egg-info`` file or directory installed alongside of it.)
97 For the ``.egg`` format, the metadata is placed in an ``EGG-INFO``
98 subdirectory, directly within the ``.egg`` file or directory.  For the
99 ``.egg-info`` format, metadata is stored directly within the
100 ``.egg-info`` directory itself.
105 this to be the only metadata file included, ``.egg-info`` format eggs
106 are not required to be a directory; they can just be a ``.egg-info``
109 *not* available for ``.egg`` formats, since setuptools always includes
111 ``.egg-info`` files, either; the support for using files was added so
115 In addition to the ``PKG-INFO`` file, an egg's metadata directory may
129 in egg filenames.  At a minimum, this includes the project name, and
133 egg filename is as follows::
151 Finally, the "ext" is either ``.egg`` or ``.egg-info``, as appropriate
152 for the egg's format.
154 Normally, an egg's filename should include at least the project name and
156 versions without having to read the egg's PKG-INFO to determine its
160 when an ``.egg`` file is built using the ``bdist_egg`` command, or when
161 an ``.egg-info`` directory is being installed by the
177 In addition to the ``.egg`` and ``.egg-info`` formats, there is a third
178 egg-related extension that you may encounter on occasion: ``.egg-link``
182 to reference an egg that is not physically installed in the desired
189 will install an ``.egg-link`` file in ``/path/to/app/plugins``, that
190 tells the egg runtime system where to find the actual egg (the user's
191 project source directory and its ``.egg-info`` subdirectory).
193 ``.egg-link`` files are named following the format for ``.egg`` and
194 ``.egg-info`` names, but only the project name is included; no version,
196 searches for available eggs, ``.egg-link`` files are opened and the
197 actual egg file/directory name is read from them.
199 Each ``.egg-link`` file should contain a single file or directory name,
201 more eggs.  That is, the name must either end in ``.egg``, or else it
202 should be the parent directory of one or more ``.egg-info`` format eggs.
206 ``.egg-link`` file, and a second line may appear in the file, specifying a
207 platform-independent relative path from the egg's base directory to its
224 Most of these files and directories are generated via "egg-info
318 was already present in the project's source ``.egg-info`` directory.
352 This directory is currently only created for ``.egg`` files built by
356 reconstituted when an ``.egg`` file is installed.
360 installation where the egg was built.  But instead of copying the
363 egg, after ensuring that sys.path includes the egg and any eggs it
376 the egg, one per line.  Paths are ``/``-separated and relative to the
377 egg's base location.
380 only appears in ``.egg`` files (and ``.egg`` directories created by
382 from a zipped egg at the same time, in case there is any direct linkage
384 information on library and resource extraction from ``.egg`` files.
392 ``/``-separated and relative to the egg's base location.
406 when installed as an ``.egg`` zipfile, and conversely the existence of
408 ``.egg`` file.  The ``zip_safe`` option to setuptools' ``setup()``
418 Note that these flag files appear only in ``.egg`` files generated by
419 ``bdist_egg``, and in ``.egg`` directories created by unpacking such an
420 ``.egg`` file.
435 an egg is added to ``sys.path`` when its contained packages may have
438 (It was also once used to detect conflicts with non-egg packages at
440 in such a way that they always override non-egg packages, thus
483 import C extensions from ``.egg`` zipfiles.  Similarly, there are many
491 or a true operating system filename for the resource.  If the egg
493 is simply returned.  However, if the egg is a zipfile, then the
506 on the enclosing ``.egg`` filename and the path to the resource.  If
543 ``pkg_resources`` to first ensure that all of the egg's C extensions
547 Note, by the way, that ``.egg`` directories will also contain these
550 import wrappers are ignored unless the egg is a zipfile.
673 subdirectory of the corresponding ``.egg`` zipfile or directory.
674 (``.egg-info`` eggs do not have script wrappers associated with them,
681 what scripts would stop working if a particular egg is uninstalled.