Debian Codegraph @

releasenotes/notes/setuptools-alignment-b5b1309f47e9cf98.yaml

raw
1 ---
2 deprecations:
3 - |
4 A number of pbr-specific `setup.cfg` sections and options have been
5 deprecated in order in favour of setuptools native `setup.cfg` sections
6 and options or their `pyproject.toml` equivalents:
7
8 - The `[entry_points]` section has been deprecated in favour of the
9 `[options.entry_points]` section (if using `setup.cfg`) or the
10 `[project.scripts]` and/or `[project.entry-points.{name}]` sections
11 (if using `pyproject.toml`)
12
13 - The `[files] packages_root` option has been deprecated in favour of the
14 `[options] package_dir` option (if using `setup.cfg`) or the
15 `[tools.setuptools] package_dir` option (if using `pyproject.toml`)
16
17 - The `[files] packages` option has been deprecated in favour of the
18 `[options] packages` option (if using `setup.cfg`) or the
19 `[tools.setuptools] packages` option (if using `pyproject.toml`)
20
21 - The `[files] package_data` option has been deprecated in favour of the
22 `[options.package_data]` option (if using `setup.cfg`) or the
23 `[tool.setuptools.package-data]` option (if using `pyproject.toml`)
24
25 - The `[files] namespace_packages` option has been deprecated in favour of
26 the `[options] namespace_packages` option (if using `setup.cfg`).
27 Alternatively, migrate to PEP 420-style namespace packages
28
29 - The `[files] data_files` option has been deprecated, and support for
30 non-package data files in general is deprecated in setuptools and their
31 use is discouraged. For package data files, use `[options] package_data`
32 (if using `setup.cfg`) or `[tools.setuptools] package_data` (if using
33 `pyproject.toml`) instead. If non-package data files are necessary, use
34 `[options] data_files` (if using `setup.cfg`) or `[tools.setuptools]
35 data-files` (if using `pyproject.toml`) instead.
36
37 - The `[files] scripts` option has been deprecated. There is no direct
38 replacement. Instead, migrate to using the `console_scripts` entrypoint
39 and use the `[options.entry_points]` option (if using `setup.cfg`) or
40 the `[project.scripts]` option (if using `pyproject.toml`).
41
42 - The `[files] modules` option has been deprecated in favour of the
43 `[options] py_modules` option (if using `setup.cfg`) or the
44 `[tools.setuptools] py-modules` option (if using `pyproject.toml`)
45
46 - The `[metadata] home_page` option has been deprecated in favour of the
47 `[metadata] url` option (if using `setup.cfg`) or the `[project.urls]`
48 option (if using `pyproject.toml`)
49
50 - The `[metadata] summary` option has been deprecated in favour of the
51 `[metadata] description` option (if using `setup.cfg`) or the `[project]
52 description` option (if using `pyproject.toml`)
53
54 - The `[metadata] classifier` option has been deprecated in favour of the
55 `[metadata] classifiers` option (if using `setup.cfg`) or the `[project]
56 classifiers` option (if using `pyproject.toml`)
57
58 - The `[metadata] platform` option has been deprecated in favour of the
59 `[metadata] platforms` option (if using `setup.cfg`) or the
60 `[tool.setuptools] platforms` (if using `pyproject.toml`)
61
62 - The `[metadata] requires_dist` option has been deprecated in favour of
63 the `[options] install_requires` option (if using `setup.cfg`) or the
64 `[project] dependencies` option (if using `pyproject.toml`)
65
66 - The `[metadata] setup_requires_dist` option has been deprecated in favour
67 of the `[options] setup_requires` option (if using `setup.cfg`) or the
68 `[build-system] requires` option (if using `pyproject.toml`)
69
70 - The `[metadata] python_requires` option has been deprecated in favour of
71 the `[options] python_requires` option (if using `setup.cfg`) or the
72 `[project] requires-python` option (if using `pyproject.toml`)
73
74 - The `[metadata] requires_python` option has been deprecated in favour of
75 the `[options] python_requires` option (if using `setup.cfg`) or the
76 `[project] requires-python` option (if using `pyproject.toml`)
77
78 - The `[metadata] provides_dist` option has been deprecated as it is
79 obsolete and is no longer used by pip
80
81 - The `[metadata] provides_extra` option has been deprecated as it is
82 obsolete and is no longer used by pip
83
84 - The `[metadata] obsoletes_dist` option has been deprecated as it is
85 obsolete and is no longer used by pip
86
87 - The `[backwards_compat] zip_safe` option has been deprecated as it is
88 was only relevant in the context of eggs and is therefore obsolete
89
90 - The `[backwards_compat] dependency_links` option has been deprecated as
91 it is obsolete and is no longer used by pip
92
93 - The `[backwards_compat] tests_require` option has been deprecated as it
94 is obsolete and is no longer used by pip
95
96 - The `[backwards_compat] include_package_data` option has been deprecated
97 in favour of the `[options] include_package_data` option (is using
98 `setup.cfg`) or the `[tools.setuptools] include-package-data` option
99 (if using `pyproject.toml`)