packaging: introduce pyproject.toml (#316)

duthils · web-flow · commit 9d7dc7655fc8 · 2025-12-15T18:14:36.000Z
phonenumberslite must now be build from python/phonenumberslite

The setup.py file is kept for retrocompatibility, in case some script
relies on `python setup.py &lt;something-else-than-build-or-install&gt;`
diff --git a/python/MANIFEST.in b/python/MANIFEST.in
@@ -1,4 +1,9 @@
-recursive-include tests *.py
 include HISTORY.md
 include LICENSE
+include appspot.py
+include run_stubtest.py
 include testwrapper.py
+include testpb2.py
+recursive-include tests *.py *.pyi
+recursive-include phonenumbers/pb2 *.py
+recursive-exclude phonenumberslite *
diff --git a/python/phonenumberslite/HISTORY.md b/python/phonenumberslite/HISTORY.md
@@ -0,0 +1 @@
+../HISTORY.md
diff --git a/python/phonenumberslite/LICENSE b/python/phonenumberslite/LICENSE
@@ -0,0 +1 @@
+../LICENSE
diff --git a/python/phonenumberslite/MANIFEST.in b/python/phonenumberslite/MANIFEST.in
@@ -0,0 +1 @@
+../MANIFEST.in
diff --git a/python/phonenumberslite/README.md b/python/phonenumberslite/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/python/phonenumberslite/phonenumbers b/python/phonenumberslite/phonenumbers
@@ -0,0 +1 @@
+../phonenumbers
diff --git a/python/phonenumberslite/pyproject.toml b/python/phonenumberslite/pyproject.toml
@@ -0,0 +1,46 @@
+[project]
+name = "phonenumberslite"
+
+authors = [{name = "David Drysdale", email = "dmd@lurklurk.org"}]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Communications :: Telephony",
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.5",
+    "Programming Language :: Python :: 2.6",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+description = "Python version of Google's common library for parsing, formatting, storing and validating international phone numbers."
+dynamic = ["version"]
+license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">=2.5"
+urls = {homepage = "https://github.com/daviddrysdale/python-phonenumbers"}
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = {attr = "phonenumbers.__version__"}
+
+[tool.setuptools]
+# phonenumbers/pb2 is considered as package data
+include-package-data = false
+
+packages = ["phonenumbers", "phonenumbers.data", "phonenumbers.shortdata"]
diff --git a/python/phonenumberslite/setup.cfg b/python/phonenumberslite/setup.cfg
@@ -0,0 +1 @@
+../setup.cfg
diff --git a/python/phonenumberslite/setup.py b/python/phonenumberslite/setup.py
@@ -0,0 +1 @@
+../setup.py
diff --git a/python/phonenumberslite/tests b/python/phonenumberslite/tests
@@ -0,0 +1 @@
+../tests
diff --git a/python/phonenumberslite/testwrapper.py b/python/phonenumberslite/testwrapper.py
@@ -0,0 +1 @@
+../testwrapper.py
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -0,0 +1,53 @@
+[project]
+name = "phonenumbers"
+
+authors = [{name = "David Drysdale", email = "dmd@lurklurk.org"}]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Communications :: Telephony",
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.5",
+    "Programming Language :: Python :: 2.6",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+description = "Python version of Google's common library for parsing, formatting, storing and validating international phone numbers."
+dynamic = ["version"]
+license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">=2.5"
+urls = {homepage = "https://github.com/daviddrysdale/python-phonenumbers"}
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+# phonenumbers/pb2 is considered as package data
+include-package-data = false
+
+packages = [
+    "phonenumbers",
+    "phonenumbers.data",
+    "phonenumbers.geodata",
+    "phonenumbers.shortdata",
+    "phonenumbers.carrierdata",
+    "phonenumbers.tzdata",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "phonenumbers.__version__"}
diff --git a/python/setup.py b/python/setup.py
@@ -15,82 +15,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import distutils.core
-import io
-import sys
-# Importing setuptools adds some features like "setup.py test", but
-# it's optional so swallow the error if it's not there.
-try:
-    import setuptools
-except ImportError:
-    pass
-
-major, minor = sys.version_info[:2]
-python_25 = (major > 2 or (major == 2 and minor >= 5))
-if not python_25:
-    raise RuntimeError("Python 2.5 or newer is required")
-
-# Discover version of phonenumbers package
-from phonenumbers import __version__
-
-# Discover whether per-prefix data is available
-if 'lite' in sys.argv:
-    lite = True
-    del sys.argv[sys.argv.index('lite')]
-else:
-    lite = False
-if not lite:
-    try:
-        import phonenumbers.tzdata
-    except ImportError:
-        lite = True
-
-with io.open("README.md", mode="r", encoding="utf-8") as readme:
-    long_description = readme.read()
-
-# Various parameters depend on whether we are the lite package or not
-if lite:
-    pkgname = 'phonenumberslite'
-    pkgs = ['phonenumbers', 'phonenumbers.data', 'phonenumbers.shortdata']
-else:
-    pkgname = 'phonenumbers'
-    pkgs = ['phonenumbers', 'phonenumbers.data', 'phonenumbers.geodata', 'phonenumbers.shortdata',
-            'phonenumbers.carrierdata', 'phonenumbers.tzdata']
-
-distutils.core.setup(name=pkgname,
-                     version=__version__,
-                     description="Python version of Google's common library for parsing, formatting, storing and validating international phone numbers.",
-                     long_description=long_description,
-                     long_description_content_type="text/markdown",
-                     author='David Drysdale',
-                     author_email='dmd@lurklurk.org',
-                     url='https://github.com/daviddrysdale/python-phonenumbers',
-                     license='Apache License 2.0',
-                     packages=pkgs,
-                     test_suite="tests.examplenumberstest",
-                     platforms='Posix; MacOS X; Windows',
-                     package_data={"": ["*.pyi", "py.typed"]},
-                     classifiers=['Development Status :: 5 - Production/Stable',
-                                  'Intended Audience :: Developers',
-                                  'License :: OSI Approved :: Apache Software License',
-                                  'Operating System :: OS Independent',
-                                  'Topic :: Communications :: Telephony',
-                                  'Programming Language :: Python :: 2',
-                                  'Programming Language :: Python :: 2.5',
-                                  'Programming Language :: Python :: 2.6',
-                                  'Programming Language :: Python :: 2.7',
-                                  'Programming Language :: Python :: 3',
-                                  'Programming Language :: Python :: 3.3',
-                                  'Programming Language :: Python :: 3.4',
-                                  'Programming Language :: Python :: 3.5',
-                                  'Programming Language :: Python :: 3.6',
-                                  'Programming Language :: Python :: 3.7',
-                                  'Programming Language :: Python :: 3.8',
-                                  'Programming Language :: Python :: 3.9',
-                                  'Programming Language :: Python :: 3.10',
-                                  'Programming Language :: Python :: 3.11',
-                                  'Programming Language :: Python :: 3.12',
-                                  'Programming Language :: Python :: Implementation :: CPython',
-                                  'Programming Language :: Python :: Implementation :: PyPy',
-                                  ],
-                     )
+import setuptools
+setuptools.setup()
diff --git a/tools/python/README.md b/tools/python/README.md
@@ -13,8 +13,7 @@ Install using `setup.py`:
 ```console
 tar xfz phonenumbers-<version>.tar.gz
 cd phonenumbers-<version>
-python setup.py build
-sudo python setup.py install  # or su first
+sudo python -m pip install .  # or su first
 ```
 
 Running Tests
@@ -134,15 +133,17 @@ Release Procedure
     `git tag vX.Y.Z`
 - Push the tag to Github with:
     `git push <github-remote> vX.Y.Z`
+- Ensure you have the requirements to build:
+    `pip install build twine`
 - Push the lite package to PyPI with:
     ```
-    cd python && rm -rf build dist && ./setup.py lite sdist bdist_wheel
+    cd python/phonenumberslite && rm -rf build dist phonenumberslite.egg-info && python -m build
     twine check dist/*
     twine upload dist/*
     ```
 - Push the package to PyPI with:
     ```
-    cd python && rm -rf build dist && ./setup.py sdist bdist_wheel
+    cd python && rm -rf build dist phonenumbers.egg-info && python -m build
     twine check dist/*
     twine upload dist/*
     ```
