Switch to PEP 517 packaging using hatchling

.github/actions/run-tests/action.yml

@@ -36,9 +36,9 @@ runs:
         set -e
 
         echo "::group::Installing dependencies"
-        pip install -U setuptools wheel
-        pip install -r requirements.txt
         pip install -r dev_requirements.txt
+        pip uninstall -y redis  # uninstall Redis package installed via redis-entraid
+        pip install -e .  # install the working copy
         if [ "${{inputs.parser-backend}}" == "hiredis" ]; then
           pip install "hiredis${{inputs.hiredis-version}}"
           echo "PARSER_BACKEND=$(echo "${{inputs.parser-backend}}_${{inputs.hiredis-version}}" | sed 's/[^a-zA-Z0-9]/_/g')" >> $GITHUB_ENV        

.github/workflows/docs.yaml

@@ -36,7 +36,7 @@ jobs:
            sudo apt-get install -yqq pandoc make
        - name: run code linters
          run: |
-           pip install -r requirements.txt -r dev_requirements.txt -r docs/requirements.txt
+           pip install -r dev_requirements.txt -r docs/requirements.txt
            invoke build-docs
 
        - name: upload docs

.github/workflows/install_and_test.sh

@@ -21,6 +21,7 @@ python -m venv ${DESTENV}
 source ${DESTENV}/bin/activate
 pip install --upgrade --quiet pip
 pip install --quiet -r dev_requirements.txt
+pip uninstall -y redis  # uninstall Redis package installed via redis-entraid
 invoke devenv --endpoints=all-stack
 invoke package
 

.github/workflows/integration.yaml

@@ -38,7 +38,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: pypa/[email protected]
         with:
-          inputs: requirements.txt dev_requirements.txt
+          inputs: dev_requirements.txt
           ignore-vulns: |
             GHSA-w596-4wvx-j9j6  # subversion related git pull, dependency for pytest. There is no impact here.
 
@@ -54,6 +54,7 @@ jobs:
       - name: run code linters
         run: |
           pip install -r dev_requirements.txt
+          pip uninstall -y redis  # uninstall Redis package installed via redis-entraid
           invoke linters
 
   redis_version:

.github/workflows/pypi-publish.yaml

@@ -18,15 +18,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.9
-      - name: Install dev tools
-        run: |
-          pip install -r dev_requirements.txt
-          pip install twine wheel
+      - run: pip install build twine
 
       - name: Build package
-        run: |
-          python setup.py build
-          python setup.py sdist bdist_wheel
+        run: python -m build .
 
       - name: Basic package test prior to upload
         run: |

CONTRIBUTING.md

@@ -38,7 +38,7 @@ Here's how to get started with your code contribution:
         a.  python -m venv .venv
         b.  source .venv/bin/activate
         c.  pip install -r dev_requirements.txt
-        c.  pip install -r requirements.txt
+        c.  pip install -e .
 
 4.  If you need a development environment, run `invoke devenv`. Note: this relies on docker-compose to build environments, and assumes that you have a version supporting [docker profiles](https://docs.docker.com/compose/profiles/).
 5.  While developing, make sure the tests pass by running `invoke tests`

dev_requirements.txt

@@ -1,3 +1,4 @@
+build
 black==24.3.0
 click==8.0.4
 flake8-isort
@@ -14,6 +15,5 @@ pytest-timeout
 ujson>=4.2.0
 uvloop
 vulture>=2.3.0
-wheel>=0.30.0
 numpy>=1.24.0
 redis-entraid==0.3.0b1

docs/examples/opentelemetry/README.md

@@ -24,7 +24,7 @@ source .venv/bin/active
 **Step 3**. Install dependencies:
 
 ```shell
-pip install -r requirements.txt
+pip install -e .
 ```
 
 **Step 4**. Start the services using Docker and make sure Uptrace is running:

pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "redis"
+dynamic = ["version"]
+description = "Python client for Redis database and key-value store"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [
+    { name = "Redis Inc.", email = "[email protected]" },
+]
+keywords = [
+    "Redis",
+    "database",
+    "key-value-store",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "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 :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+    'async-timeout>=4.0.3; python_full_version<"3.11.3"',
+    "PyJWT~=2.9.0",
+]
+
+[project.optional-dependencies]
+hiredis = [
+    "hiredis>=3.0.0",
+]
+ocsp = [
+    "cryptography>=36.0.1",
+    "pyopenssl==20.0.1",
+    "requests>=2.31.0",
+]
+
+[project.urls]
+Changes = "https://github.com/redis/redis-py/releases"
+Code = "https://github.com/redis/redis-py"
+Documentation = "https://redis.readthedocs.io/en/latest/"
+Homepage = "https://github.com/redis/redis-py"
+"Issue tracker" = "https://github.com/redis/redis-py/issues"
+
+[tool.hatch.version]
+path = "redis/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/redis",
+]

redis/__init__.py

@@ -1,5 +1,3 @@
-from importlib import metadata
-
 from redis import asyncio  # noqa
 from redis.backoff import default_backoff
 from redis.client import Redis, StrictRedis
@@ -44,16 +42,9 @@ def int_or_str(value):
         return value
 
 
-try:
-    __version__ = metadata.version("redis")
-except metadata.PackageNotFoundError:
-    __version__ = "99.99.99"
-
+__version__ = "5.2.1"
+VERSION = tuple(map(int_or_str, __version__.split(".")))
 
-try:
-    VERSION = tuple(map(int_or_str, __version__.split(".")))
-except AttributeError:
-    VERSION = tuple([99, 99, 99])
 
 __all__ = [
     "AuthenticationError",

tasks.py

@@ -97,4 +97,4 @@ def clean(c):
 @task
 def package(c):
     """Create the python packages"""
-    run("python setup.py sdist bdist_wheel")
+    run("python -m build .")