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

Use SPDX license identifier #1076

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use SPDX license identifier #1076

wants to merge 1 commit into from

Conversation

cdce8p
Copy link

@cdce8p cdce8p commented Nov 18, 2024

Changes

Use the SPDX license identifier as recommended by PEP 639.
https://spdx.org/licenses/Apache-2.0.html

Copy link

codecov bot commented Nov 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.09%. Comparing base (49a5573) to head (fa62c44).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1076   +/-   ##
=======================================
  Coverage   95.09%   95.09%           
=======================================
  Files         114      114           
  Lines       16981    16981           
  Branches     1579     1579           
=======================================
  Hits        16148    16148           
  Misses        485      485           
  Partials      348      348           
Flag Coverage Δ
cext 94.90% <ø> (ø)
integration 94.83% <ø> (ø)
purepy 94.90% <ø> (ø)
unit 53.08% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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


🚨 Try these New Features:

@@ -6,7 +6,7 @@ name = "aiokafka"
description = "Kafka integration with asyncio"
readme = "README.rst"
requires-python = ">=3.9"
license = { file = "LICENSE" }
license = { text = "Apache-2.0" }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to PEP, this ways is deprecated:

Table values for the license key in the [project] table, including the text and file table subkeys, are now deprecated.

Suggested change
license = { text = "Apache-2.0" }
license = "Apache-2.0"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Unfortunately setuptools doesn't support the new syntax yet. Using license.text until then will make updating later a bit easier and also help with readability on PyPI.

before

Screenshot 2024-11-19 at 08 37 26

after

Screenshot 2024-11-19 at 08 38 02

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably it's time to switch to hatch (need to figure out how to deal with cython to do this). If not, I'd rather wait until setuptools is fixed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If not, I'd rather wait until setuptools is fixed.

This will take some time, probably months. It's currently blocked by other issues which need to be worked out first. pypa/setuptools#4629

I've opened the PR here now, as using the SPDX expression even for the "legacy" License field can help tools which parse the project metadata to look licenses.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants