Switch from setup.py to pyproject.toml

[mkmkme]

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

Pull Request check-list

• Do tests and lints pass with this change?
• Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
• Is the new or changed code fully tested?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Is there an example added to the examples folder (if applicable)?

Description of change

Switch from setup.py to pyproject.toml

[mkmkme]

@trim21 would you be able to review this one? Thanks!

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.26%. Comparing base (b59ee44) to head (dc3518a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #230      +/-   ##
==========================================
- Coverage   76.27%   76.26%   -0.01%     
==========================================
  Files         130      129       -1     
  Lines       33913    33911       -2     
==========================================
- Hits        25867    25863       -4     
- Misses       8046     8048       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[trim21]

wheel is not necessary anymore

[trim21]

This is also not necessary

[mkmkme]

Thanks everyone for the reviews! I'll double-check tonight whether the changes in the comments are really needed and will either fix or merge this

[amirreza8002]

just an fyi

i think? people can now do pip install valkey[dev] and get from pypi
same thing goes for doc

some package managers (uv, poetry) have a way to prevent this

[mkmkme]

Yeah that's a great point.

If there's a way to do that with pyproject itself, I'm all for it.

Alternatively, we can also do what redis-py has done, that is switching to pyproject but keeping dev_requirements.txt and docs/requirements.txt. Honestly this sounds like the best approach.

@bogdanp05 WDYT?

[amirreza8002]

https://github.com/django-commons/django-valkey/blob/main/pyproject.toml#L60

this clause is documented in pyproject docs

but if i understand correctly it needs a lock file to work, so a package manager is needed

[amirreza8002]

there is a chance my data is outdated and it can be used as is
https://packaging.python.org/en/latest/specifications/dependency-groups/

[trim21]

use dependency-groups and replace pip with uv in our ci would help. replace pip install .[dev] with uv sync --group dev

[amirreza8002]

i just found out you can use pip to install dependency groups
tho it's a new feature (like 5 month old)
pip install --group test

good thing about pyproject is that it's a standard format, so you can replace pip with uv or poetry or vis versa and it just works

[amirreza8002]

also you might consider a build tool that's not setuptools ;)

it lacks some features, I've had cases where it couldn't even publish to pypi cause it lacked the new standard

[mkmkme]

also you might consider a build tool that's not setuptools ;)

it lacks some features, I've had cases where it couldn't even publish to pypi cause it lacked the new standard

Thanks a lot! I'll look into it. Do you have any suggestions for the alternative?

[trim21]

also you might consider a build tool that's not setuptools ;)
it lacks some features, I've had cases where it couldn't even publish to pypi cause it lacked the new standard

Thanks a lot! I'll look into it. Do you have any suggestions for the alternative?

flit-core

[mkmkme]

also you might consider a build tool that's not setuptools ;)
it lacks some features, I've had cases where it couldn't even publish to pypi cause it lacked the new standard

Thanks a lot! I'll look into it. Do you have any suggestions for the alternative?

Note to myself: redis-py uses hatchling, might worth looking into it as well.

[amirreza8002]

i use hatch everywhere

it does the job without noise

but I'm not an expert in this matter and don't have a strong suggestion