Skip to content

📝 docs: explain the two licenses in README - #28

Merged
gaborbernat merged 1 commit into
tox-dev:mainfrom
gaborbernat:docs-license-split
Nov 18, 2026
Merged

gaborbernat merged 1 commit into
tox-dev:mainfrom
gaborbernat:docs-license-split

Conversation

@gaborbernat

Copy link
Copy Markdown
Member

Someone packaging python-sbom downstream sees two license answers: the root LICENSE says MIT, and GitHub's license badge repeats it because it reads only that file, while the package metadata on PyPI says MIT AND Apache-2.0. Nothing a visitor reads first explains the gap, which led to the question in #27. 📝 The README now has a License section that states which license covers what and links both license texts.

Both answers are right, for different scopes. The project's own code is MIT. The wheel and source distribution also carry the schema files that python-sbom validate checks documents against, copied unmodified from CycloneDX/specification, which is Apache-2.0. That license text already ships next to the schemas. A license expression describes everything in the distribution, so it names both.

The change is the README section and a changelog entry. The license metadata and the contents of the distributions stay as they are.

The metadata declares MIT AND Apache-2.0 while the root LICENSE and
GitHub's badge show MIT only. State that the project code is MIT and
the bundled CycloneDX schema files are Apache-2.0. Refs tox-dev#27.
@gaborbernat gaborbernat added the documentation Improvements or additions to documentation label Nov 18, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 python-sbom | 🛠️ Build #35974875 | 📁 Comparing 6228d24 against latest (9b9bfb7)

  🔍 Preview build  

1 file changed
± changelog.html

@gaborbernat
gaborbernat merged commit 7eeb903 into tox-dev:main Nov 18, 2026
38 checks passed
@gaborbernat gaborbernat mentioned this pull request Nov 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant