Migrate to pyproject.toml and hatchling (elastic#2600)

Author: pquentin

.readthedocs.yml

@@ -11,5 +11,6 @@ build:
 
 python:
   install:
-    - requirements: dev-requirements.txt
     - path: .
+      extra_requirements:
+        - "docs"

MANIFEST.in

@@ -22,7 +22,6 @@
 SOURCE_DIR = os.path.dirname(os.path.abspath(__file__))
 SOURCE_FILES = (
     "docs/sphinx/conf.py",
-    "setup.py",
     "noxfile.py",
     "elasticsearch/",
     "test_elasticsearch/",
@@ -48,22 +47,17 @@ def pytest_argv():
 
 @nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"])
 def test(session):
-    session.install(
-        ".[async,requests,orjson,vectorstore_mmr]", env=INSTALL_ENV, silent=False
-    )
-    session.install("-r", "dev-requirements.txt", silent=False)
+    session.install(".[dev]", env=INSTALL_ENV, silent=False)
 
     session.run(*pytest_argv())
 
 
 @nox.session(python=["3.7", "3.12"])
 def test_otel(session):
-    session.install(".[async,requests]", env=INSTALL_ENV, silent=False)
     session.install(
+        ".[dev]",
         "opentelemetry-api",
         "opentelemetry-sdk",
-        "-r",
-        "dev-requirements.txt",
         silent=False,
     )
 
@@ -129,8 +123,5 @@ def lint(session):
 
 @nox.session()
 def docs(session):
-    session.install("-rdev-requirements.txt")
-    session.install(".")
-    session.run("python", "-m", "pip", "install", "sphinx-autodoc-typehints")
-
+    session.install(".[docs]")
     session.run("sphinx-build", "docs/sphinx/", "docs/sphinx/_build", "-b", "html")

dev-requirements.txt

@@ -0,0 +1,123 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "elasticsearch"
+description = "Python client for Elasticsearch"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.7"
+authors = [
+    { name = "Elastic Client Library Maintainers", email = "[email protected]" },
+]
+maintainers = [
+    { name = "Elastic Client Library Maintainers", email = "[email protected]" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "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",
+]
+keywords = [
+    "elasticsearch",
+    "elastic",
+    "kibana",
+    "mapping",
+    "REST",
+    "search",
+    "client",
+    "index",
+]
+dynamic = ["version"]
+dependencies = [
+    "elastic-transport>=8.13,<9",
+]
+
+[project.optional-dependencies]
+async = ["aiohttp>=3,<4"]
+requests = ["requests>=2.4.0, !=2.32.2, <3.0.0"]
+orjson = ["orjson>=3"]
+# Maximal Marginal Relevance (MMR) for search results
+vectorstore_mmr = ["numpy>=1", "simsimd>=3"]
+dev = [
+    "requests>=2, <3",
+    "aiohttp",
+    "pytest",
+    "pytest-cov",
+    "pytest-asyncio",
+    "coverage",
+    "jinja2",
+    "python-dateutil",
+    "unasync",
+    "pyyaml>=5.4",
+    "isort",
+    "black",
+    "twine",
+    "build",
+    "nox",
+    "orjson",
+    "numpy",
+    "simsimd",
+    "pandas",
+    "mapbox-vector-tile",
+    # Python 3.7 gets an old version of mapbox-vector-tile, requiring an old version of protobuf
+    "protobuf<4; python_version<=\"3.7\"",
+]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "sphinx-autodoc-typehints"
+]
+
+[project.urls]
+Documentation = "https://elasticsearch-py.readthedocs.io/"
+Homepage = "https://github.com/elastic/elasticsearch-py"
+"Issue Tracker" = "https://github.com/elastic/elasticsearch-py/issues"
+"Source Code" = "https://github.com/elastic/elasticsearch-py"
+
+[tool.hatch.version]
+path = "elasticsearch/_version.py"
+pattern = "__versionstr__ = \"(?P<version>[^']+)\""
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/elasticsearch",
+    "/CHANGELOG.md",
+    "/CONTRIBUTING.md",
+    "/LICENSE",
+    "/NOTICE",
+    "/README.md",
+    "/setup.cfg",
+    "/docs/sphinx",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["elasticsearch"]
+
+[tool.pytest.ini_options]
+junit_family = "legacy"
+xfail_strict = true
+markers = "otel"
+
+[tool.isort]
+profile = "black"
+
+[tool.coverage.report]
+exclude_lines = [
+    "raise NotImplementedError*",
+]
+
+[tool.mypy]
+ignore_missing_imports = true

noxfile.py

@@ -1,17 +1,2 @@
 [flake8]
 ignore = E203, E266, E501, W503
-
-[tool:pytest]
-junit_family=legacy
-addopts = -vvv --cov-report=term-missing --cov=elasticsearch --cov-config=.coveragerc
-markers = otel
-
-[tool:isort]
-profile=black
-
-[report]
-exclude_lines=
-    raise NotImplementedError*
-
-[mypy]
-ignore_missing_imports = True

pyproject.toml

@@ -17,7 +17,7 @@
 
 """A command line tool for building and verifying releases
 Can be used for building both 'elasticsearch' and 'elasticsearchX' dists.
-Only requires 'name' in 'setup.py' and the directory to be changed.
+Only requires 'name' in 'pyproject.toml' and the directory to be changed.
 """
 
 import contextlib
@@ -170,8 +170,8 @@ def test_dist(dist):
 
 
 def main():
-    run("git", "checkout", "--", "setup.py", "elasticsearch/")
-    run("rm", "-rf", "build/", "dist/*", "*.egg-info", ".eggs")
+    run("git", "checkout", "--", "pyproject.toml", "elasticsearch/")
+    run("rm", "-rf", "dist")
 
     # Grab the major version to be used as a suffix.
     version_path = os.path.join(base_dir, "elasticsearch/_version.py")
@@ -249,25 +249,19 @@ def main():
             f.truncate()
             f.write(version_data)
 
-        # Rewrite setup.py with the new name.
-        setup_py_path = os.path.join(base_dir, "setup.py")
-        with open(setup_py_path) as f:
-            setup_py = f.read()
-        with open(setup_py_path, "w") as f:
+        # Rewrite pyproject.toml with the new name.
+        pyproject_toml_path = os.path.join(base_dir, "pyproject.toml")
+        with open(pyproject_toml_path) as f:
+            pyproject_toml = f.read()
+        with open(pyproject_toml_path, "w") as f:
             f.truncate()
-            assert 'package_name = "elasticsearch"' in setup_py
-            f.write(
-                setup_py.replace(
-                    'package_name = "elasticsearch"',
-                    f'package_name = "elasticsearch{suffix}"',
-                )
-            )
+            f.write(pyproject_toml.replace("elasticsearch", f"elasticsearch{suffix}"))
 
         # Build the sdist/wheels
         run("python", "-m", "build")
 
         # Clean up everything.
-        run("git", "checkout", "--", "setup.py", "elasticsearch/")
+        run("git", "checkout", "--", "pyproject.toml", "elasticsearch/")
         if suffix:
             run("rm", "-rf", f"elasticsearch{suffix}/")