Switch from setup.py to pyproject.toml (#230)

Highly inspired by #96 by @ds-cbo (Thanks!)

Signed-off-by: Mikhail Koviazin <[email protected]>

Author: mkmkme

.github/wordlist.txt

@@ -90,6 +90,7 @@ firsttimersonly
 fo
 genindex
 gmail
+hatchling
 html
 http
 https
@@ -128,6 +129,7 @@ pubsub
 punsubscribe
 py
 pypi
+pyproject
 quickstart
 readonly
 readwrite
@@ -149,6 +151,7 @@ subcommands
 thevalueofmykey
 timeseries
 toctree
+toml
 topk
 triaging
 txt

.github/workflows/docs.yaml

@@ -38,7 +38,8 @@ 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 --group dev --group docs
+           pip install .
            invoke build-docs
 
        - name: upload docs

.github/workflows/install_and_test.sh

@@ -19,8 +19,8 @@ if [ -d ${DESTENV} ]; then
 fi
 python -m venv ${DESTENV}
 source ${DESTENV}/bin/activate
-pip install --upgrade --quiet pip setuptools wheel
-pip install --quiet -r dev_requirements.txt
+pip install --upgrade --quiet pip
+pip install --quiet --group dev
 invoke devenv
 invoke package
 

.github/workflows/integration.yaml

@@ -32,7 +32,7 @@ jobs:
        - uses: actions/checkout@v5
        - uses: pypa/[email protected]
          with:
-           inputs: requirements.txt dev_requirements.txt
+           inputs: .
            ignore-vulns: |
              GHSA-w596-4wvx-j9j6  # subversion related git pull, dependency for pytest. There is no impact here.
 
@@ -47,7 +47,7 @@ jobs:
            cache: 'pip'
        - name: run code linters
          run: |
-           pip install -r dev_requirements.txt
+           pip install --group dev
            invoke linters
 
    get-date:
@@ -115,9 +115,8 @@ jobs:
 
        - name: run tests
          run: |
-           pip install -U setuptools wheel
-           pip install -r requirements.txt
-           pip install -r dev_requirements.txt
+           pip install --group dev
+           pip install .
            if [ "${{matrix.connection-type}}" == "libvalkey" ]; then
             pip install "libvalkey>=4.0.1"
            fi

.github/workflows/pypi-publish.yaml

@@ -22,13 +22,12 @@ jobs:
           python-version: 3.9
       - name: Install dev tools
         run: |
-          pip install -r dev_requirements.txt
-          pip install twine wheel
+          pip install --group dev
+          pip install twine
 
       - name: Build package
         run: |
-          python setup.py build
-          python setup.py sdist bdist_wheel
+          hatchling build
 
       - name: Basic package test prior to upload
         run: |

.readthedocs.yml

@@ -1,14 +1,14 @@
 version: 2
 
-python:
-  install:
-    - requirements: ./docs/requirements.txt
-    - requirements: requirements.txt
-
 build:
   os: ubuntu-20.04
   tools:
     python: "3.13"
+  jobs:
+    install:
+      - pip install --upgrade pip
+      - pip install --group docs
+      - pip install .
 
 sphinx:
   configuration: docs/conf.py

CONTRIBUTING.md

@@ -89,12 +89,11 @@ Here's how to get started with your code contribution:
 1.  Create your own fork of valkey-py
 2.  Do the changes in your fork
 3.
-    *Create a virtualenv and install the development dependencies from the dev_requirements.txt file:*
+    *Create a virtualenv and install the development dependencies from the dev group:*
 
         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 --group dev
 
 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`
@@ -105,8 +104,7 @@ To see what else is part of the automation, run `invoke -l`
 
 ## The Development Environment
 
-Running `invoke devenv` installs the development dependencies specified
-in the dev_requirements.txt. It starts all of the dockers used by this
+Running `invoke devenv` starts all of the dockers used by this
 project, and leaves them running. These can be easily cleaned up with
 `invoke clean`. NOTE: it is assumed that the user running these tests,
 can execute docker and its various commands.

INSTALL

@@ -1,6 +1,5 @@
 
 Please use
- python setup.py install
-
-and report errors to via https://github.com/valkey-io/valkey-py/issues/new
+ pip install .
 
+and report errors to us via https://github.com/valkey-io/valkey-py/issues/new