Skip to content

docs: clarify LGPL-2.1-or-later license in README#1763

Merged
bdraco merged 1 commit into
python-zeroconf:masterfrom
bluetoothbot:koan/fix-issue-1600
May 20, 2026
Merged

docs: clarify LGPL-2.1-or-later license in README#1763
bdraco merged 1 commit into
python-zeroconf:masterfrom
bluetoothbot:koan/fix-issue-1600

Conversation

@bluetoothbot

@bluetoothbot bluetoothbot commented May 20, 2026

Copy link
Copy Markdown
Contributor

Summary

The COPYING file ships the verbatim text of LGPL 2.1, but pyproject.toml declares the SPDX identifier LGPL-2.1-or-later. License-detection tools (e.g. LicenseCheck) report the project as "or later" while the README only said "LGPL, see COPYING file for details", leaving downstream consumers unsure which version applies.

This change states the "or later" grant explicitly in the README so the README, COPYING, and pyproject.toml agree.

Fixes #1600

Changes

  • README: replace the one-line License section with an explicit LGPL-2.1-or-later statement that cites COPYING and pyproject.toml.

Test plan

  • Documentation-only change; no code paths affected.
  • pyproject.toml license = "LGPL-2.1-or-later" unchanged — README now matches.

Generated by Kōan /fix


Quality Report

Changes: 1 file changed, 7 insertions(+), 1 deletion(-)

Code scan: clean

Tests: passed (4 PASSED)

Branch hygiene: clean

Generated by Kōan post-mission quality pipeline

The COPYING file ships the verbatim text of LGPL 2.1, while the
package metadata in pyproject.toml declares the SPDX identifier
LGPL-2.1-or-later. License-detection tools that read pyproject.toml
report the project as 'or later', but the README only said 'LGPL,
see COPYING file for details', leaving downstream consumers unsure
which version applies.

State the 'or later' grant explicitly in the README so the README,
COPYING, and pyproject.toml agree on a single, machine- and
human-readable answer.
@codecov

codecov Bot commented May 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.77%. Comparing base (cb0af4a) to head (fe02c56).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1763   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          33       33           
  Lines        3500     3500           
  Branches      490      490           
=======================================
  Hits         3492     3492           
  Misses          5        5           
  Partials        3        3           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codspeed-hq

codspeed-hq Bot commented May 20, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 14 untouched benchmarks


Comparing bluetoothbot:koan/fix-issue-1600 (fe02c56) with master (cb0af4a)

Open in CodSpeed

@bdraco bdraco marked this pull request as ready for review May 20, 2026 17:34
@bdraco bdraco merged commit 28bb01f into python-zeroconf:master May 20, 2026
36 checks passed
@bluetoothbot bluetoothbot deleted the koan/fix-issue-1600 branch May 20, 2026 19:28
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.

Please clarify which LGPL version applies

2 participants