Skip to content

Commit dc1f367

Browse files
jdemeyertheacodes
authored andcommitted
Fix section on data_files (pypa#490)
1 parent 20b503e commit dc1f367

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

source/tutorials/distributing-packages.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -446,26 +446,26 @@ data_files
446446
Although configuring :ref:`Package Data` is sufficient for most needs, in some
447447
cases you may need to place data files *outside* of your :term:`packages
448448
<Import Package>`. The ``data_files`` directive allows you to do that.
449+
It is mostly useful if you need to install files which are used by other
450+
programs, which may be unaware of Python packages.
449451

450-
Each (directory, files) pair in the sequence specifies the installation
451-
directory and the files to install there. If directory is a relative path, it
452-
is interpreted relative to the installation prefix (Python’s ``sys.prefix`` for
453-
pure-Python :term:`distributions <Distribution Package>`, ``sys.exec_prefix``
454-
for distributions that contain extension modules). Each file name in files is
455-
interpreted relative to the :file:`setup.py` script at the top of the project
456-
source distribution.
452+
Each ``(directory, files)`` pair in the sequence specifies the installation
453+
directory and the files to install there. The ``directory`` must be a relative
454+
path (although this may change in the future, see
455+
`wheel Issue #92 <https://github.com/pypa/wheel/issues/92>`_).
456+
and it is interpreted relative to the installation prefix (Python’s ``sys.prefix``).
457+
Each file name in ``files`` is interpreted relative to the :file:`setup.py`
458+
script at the top of the project source distribution.
457459

458460
For more information see the distutils section on `Installing Additional Files
459461
<http://docs.python.org/3/distutils/setupscript.html#installing-additional-files>`_.
460462

461463
.. note::
462464

463-
:ref:`setuptools` allows absolute "data_files" paths, and pip honors them as
464-
absolute, when installing from :term:`sdist <Source Distribution (or
465-
"sdist")>`. This is not true when installing from :term:`wheel`
466-
distributions. Wheels don't support absolute paths, and they end up being
467-
installed relative to "site-packages". For discussion see `wheel Issue #92
468-
<https://github.com/pypa/wheel/issues/92>`_.
465+
When installing packages as egg, ``data_files`` is not supported.
466+
So, if your project uses :ref:`setuptools`, you must use ``pip``
467+
to install it. Alternatively, if you must use ``python setup.py``,
468+
then you need to pass the ``--old-and-unmanageable`` option.
469469

470470

471471
scripts

0 commit comments

Comments
 (0)