diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-05-16 13:21:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-16 13:21:57 +0100 |
| commit | 508d61ca81bc4838ccecec43f1acb6762e189dd0 (patch) | |
| tree | 5b550bd4e837487ca7bdbcd2ced3bfcc5eef27d1 /docs/deprecated | |
| parent | 1b25c061e54714dbea68c5194b74f09191ce6381 (diff) | |
| parent | 63d16710e7a698a10470436b6c786306c8afb580 (diff) | |
| download | python-setuptools-git-508d61ca81bc4838ccecec43f1acb6762e189dd0.tar.gz | |
Docs: Combine keyword documentation (#3307)
Diffstat (limited to 'docs/deprecated')
| -rw-r--r-- | docs/deprecated/changed_keywords.rst | 112 | ||||
| -rw-r--r-- | docs/deprecated/index.rst | 1 |
2 files changed, 113 insertions, 0 deletions
diff --git a/docs/deprecated/changed_keywords.rst b/docs/deprecated/changed_keywords.rst new file mode 100644 index 00000000..7db372f2 --- /dev/null +++ b/docs/deprecated/changed_keywords.rst @@ -0,0 +1,112 @@ +New and Changed ``setup()`` Keywords +==================================== + +This document tracks historical differences between ``setuptools`` and +``distutils``. + +Since ``distutils`` was scheduled for removal from the standard library in +Python 3.12, and ``setuptools`` started its adoption, these differences became less +relevant. +Please check :doc:`/references/keywords` for a complete list of keyword +arguments that can be passed to the ``setuptools.setup()`` function and +a their full description. + +.. tab:: Supported by both ``distutils`` and ``setuptoools`` + + ``name`` string + + ``version`` string + + ``description`` string + + ``long_description`` string + + ``long_description_content_type`` string + + ``author`` string + + ``author_email`` string + + ``maintainer`` string + + ``maintainer_email`` string + + ``url`` string + + ``download_url`` string + + ``packages`` list + + ``py_modules`` list + + ``scripts`` list + + ``ext_package`` string + + ``ext_modules`` list + + ``classifiers`` list + + ``distclass`` Distribution subclass + + ``script_name`` string + + ``script_args`` list + + ``options`` dictionary + + ``license`` string + + ``license_file`` string **deprecated** + + ``license_files`` list + + ``keywords`` string or list + + ``platforms`` list + + ``cmdclass`` dictionary + + ``data_files`` list **deprecated** + + ``package_dir`` dictionary + + ``requires`` string or list **deprecated** + + ``obsoletes`` list **deprecated** + + ``provides`` list + +.. tab:: Added or changed by ``setuptoools`` + + ``include_package_data`` bool + + ``exclude_package_data`` dictionary + + ``package_data`` dictionary + + ``zip_safe`` bool + + ``install_requires`` string or list + + ``entry_points`` dictionary + + ``extras_require`` dictionary + + ``python_requires`` string + + ``setup_requires`` string or list **deprecated** + + ``dependency_links`` list **deprecated** + + ``namespace_packages`` list + + ``test_suite`` string or function **deprecated** + + ``tests_require`` string or list **deprecated** + + ``test_loader`` class **deprecated** + + ``eager_resources`` list + + ``project_urls`` dictionary diff --git a/docs/deprecated/index.rst b/docs/deprecated/index.rst index 59fc7bef..8169b3b7 100644 --- a/docs/deprecated/index.rst +++ b/docs/deprecated/index.rst @@ -13,6 +13,7 @@ objectives. .. toctree:: :maxdepth: 1 + changed_keywords python_eggs easy_install distutils/index |
