Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Setup.py With Pyproject.toml and Ensure Correct spdx-tools Dependency Specified #40

Closed
jspeed-meyers opened this issue Jan 10, 2023 · 1 comment · Fixed by #47
Labels
enhancement New feature or request good first issue Good for newcomers P1 Medium priority

Comments

@jspeed-meyers
Copy link
Collaborator

jspeed-meyers commented Jan 10, 2023

The current setup.py resulted in a recent hiccup for spdx-online-tools: spdx/spdx-online-tools#418

@jspeed-meyers jspeed-meyers added question Further information is requested P2 Low priority and removed question Further information is requested labels Jan 10, 2023
@jspeed-meyers
Copy link
Collaborator Author

While investigating this, I discovered that setup.py files are no longer the recommended way to do Python packaging.

See https://setuptools.pypa.io/en/latest/userguide/quickstart.html#setup-py

Instead, pyproject.toml is recommended.

Additionally, this pyproject.toml file should indeed include spdx-tools.

So here's the task for a future PR:

  • Remove setup.py
  • Replace with a pyproject.toml
  • Ensure that pyproject.toml includes the spdx-tools dependency

The pyproject.toml should be something like this:

[project]
name = "ntia-conformance-checker"
version = "0.0.2"
dependencies = [
    "spdx-tools>=0.7.0rc0",
]

The pyproject.toml file will also need to specify where the package is.

@jspeed-meyers jspeed-meyers added the enhancement New feature or request label Jan 15, 2023
@jspeed-meyers jspeed-meyers changed the title Should Setup.py Include tools-python PyPI Package as Dependency? Replace Setup.py With Pyproject.toml and Ensure Correct spdx-tools Dependency Specified Jan 15, 2023
@jspeed-meyers jspeed-meyers added P1 Medium priority good first issue Good for newcomers and removed P2 Low priority labels Jan 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers P1 Medium priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant