Skip to content

docs: warn about data_files usage #2073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Himanshuagrawal4 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

docs: warn about data_files usage #2073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/guides/distributing-packages-using-setuptools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,13 @@ For more information, see :std:doc:`Including Data Files

data_files=[('my_data', ['data/data_file'])],

.. warning::

``data_files`` is a legacy installation mechanism and is deprecated in
setuptools' declarative configuration. Prefer :ref:`Package Data` for files
that belong inside an import package, and reserve ``data_files`` for
last-resort cases that need to place files outside Python packages.

Although configuring :ref:`Package Data` is sufficient for most needs, in some
cases you may need to place data files *outside* of your :term:`packages
<Import Package>`. The ``data_files`` directive allows you to do that.
Expand Down
Loading