Skip to content

fix(packaging): declare the Apache 2.0 licence and use absolute README links - #255

Merged
glebedel merged 2 commits into
mainfrom
s2d2/audit-pypi-metadata
Nov 11, 2026
Merged

glebedel merged 2 commits into
mainfrom
s2d2/audit-pypi-metadata

Conversation

@glebedel

@glebedel glebedel commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

What

  • pyproject.toml: the licence classifier said MIT License, but LICENSE is Apache 2.0 and the README says "Apache 2.0 License". PyPI shows the classifier, so the package page advertised the wrong licence. The MIT classifier is removed and the licence is now declared as a PEP 639 expression: license = "Apache-2.0" with license-files = ["LICENSE"].
  • README.md is the PyPI long description (readme = "README.md"). Its relative links to examples/ and MIGRATION.md#... resolve to nothing on PyPI. They now point at github.com/StackOneHQ/stackone-ai-python/blob/main/..., the same form README line 13 already uses.

How verified

  • uv build: the wheel METADATA now carries License-Expression: Apache-2.0 and no licence classifier.
  • Every rewritten link target exists in the tree (examples/*.py, examples/, MIGRATION.md heading "Tool arguments and headers").
  • uv lock --check clean (the classifier is not in the lock).

Gates (head e66be80)

Gate Result
Repo skills none in repo
/forge:forge ran on 5718aab: meter 0/0, no change; re-run on e66be80: 0 comment lines, 0 copies
Security scan security-reviewer agent: no finding at confidence 70 or above. Aikido: 31 open issues on main (lockfile CVEs, workflow SAST, one old test-fixture secret), none on lines this PR changes
Codex security clean on e66be80 (job b2f55e81)
/security-review ran: secrets, input validation, transport and DoS items clean; the server-side items do not apply to an SDK
/code-review medium on 5718aab, 6 candidates. Fixed 3: the licence is now a PEP 639 expression (license = "Apache-2.0", license-files, hatchling>=1.27; the built wheel METADATA has License-Expression: Apache-2.0), the last same-page anchor is absolute, and changed lines carry no dashes. Declined 3: links to main (answered on the Aikido thread), [project.urls] (added in #262), reference-style links (style only)
CI green on e66be80: 10 pass, 3 skipped
Unresolved review threads 0

Requested by guillaume@stackone.com in Slack (repo audit thread).

🤖 Generated with Claude Code


Summary by cubic

Fixes PyPI metadata so the package page shows the correct licence and working links.

  • The licence classifier in pyproject.toml said MIT while LICENSE and the README say Apache 2.0; it now declares Apache Software License.
  • README.md is the PyPI long description, so relative links to examples/ and MIGRATION.md resolved to nothing on PyPI; they now point to github.com/StackOneHQ/stackone-ai-python.

Written for commit 5718aab. Summary will update on new commits.

View guided diff Turn on auto-fix

…E links

The classifier said MIT while LICENSE and the README say Apache 2.0, so PyPI
showed the wrong licence. The README is the PyPI long description, where
relative links to examples/ and MIGRATION.md resolve to nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.com>
@glebedel glebedel self-assigned this Nov 10, 2026
Comment thread README.md Resolved
The classifier alone left the wheel without a License-Expression, so licence
scanners that read the metadata field report it as unknown. hatchling 1.27 is
the first release that writes it. The last same-page README anchor becomes an
absolute link, since PyPI does not render heading ids.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Guillaume Lebedel <10488548+glebedel@users.noreply.github.com>
@glebedel
glebedel merged commit dc214cb into main Nov 11, 2026
15 checks passed
@glebedel
glebedel deleted the s2d2/audit-pypi-metadata branch November 11, 2026 10:56
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