Switch to PEP 517 packaging using hatchling (redis#2930)

* Switch to PEP 517 packaging using hatchling

Refs redis#1316
Refs redis#1649
Remake of redis#2388

Co-authored-by: Ofek Lev <[email protected]>

* Use a single source of truth for version info

* Uninstall redis wheel installed as redis-entraid dep

* Add build as dev_requirement

* Get rid of requirements.txt

* Get rid of setuptools and wheel deps

* Move pytest configuration to pyproject.toml

* Retain tests and dev_requirements.txt in sdist

---------

Co-authored-by: Ofek Lev <[email protected]>

Author: 2 people

.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`

INSTALL

@@ -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

MANIFEST.in

@@ -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: