ni / ni/nimi-python

Modernize nimi-python setup.py projects with pyproject.toml

Open
#2,095 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

build codegen task
Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.