Modernize nimi-python setup.py projects with pyproject.toml
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- build-system
Research direction
Start by locating the setup.py projects in the nimi-python repository and read the linked Python Packaging User Guide on modernizing setup.py projects. Add the required pyproject.toml configuration for each project, then verify that packaging no longer requires the deprecated license classifier. Resolve how the MIT and NI General Purpose EULA licenses should be represented before considering the work done.
Written by the indexing model from the issue text.
Description
We've started receiving messages like this during codegen:
/tmp/build-env-w9fmceq7/lib/python3.12/site-packages/setuptools/dist.py:759: SetuptoolsDeprecationWarning: License classifiers are deprecated.
!!
********************************************************************************
Please consider removing the following classifiers in favor of a SPDX license expression:
License :: OSI Approved :: MIT License
See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license for details.
********************************************************************************
!!
self._finalize_license_expression()
This is telling us to stop specifying "License :: OSI Approved :: MIT License" in the setup.py classifiers in favor of this SPDX format ... in a pyproject.toml, which we don't have.
The pyproject.toml format wants us to specify something like
[project]
license = "MIT"
license-files = ["LICENSE", "NILICENSE"]
Maybe we would need to AND with another license in the "license" field for the "NI General Purpose EULA" that's covered in the NILICENSE file. This may be a bigger discussion that we need to have internally.
Before we can do that, though, we'll first need to add a pyproject.toml.
See https://packaging.python.org/en/latest/guides/modernize-setup-py-project/#modernize-setup-py-project
Although pyproject.toml is not required yet, it's strongly recommended.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ni/nimi-python
-
docs nitclk priority-low
Difficulty 1/5 Under an hour Newbie friendliness 68/100
ni/nimi-python#1993 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ni/nimi-python#2164 · 1 comment ·
-
bug docs
Difficulty 1/5 Under an hour Newbie friendliness 48/100
ni/nimi-python#2162 ·
-
codegen enhancement
Difficulty 4/5 3-5 days Newbie friendliness 42/100
ni/nimi-python#2148 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ni/nimi-python#2122 ·
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
canonical/paas-charm#368 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
StevenBlack/hosts#3256 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
qualcomm/qai-appbuilder#275 ·