Skip to content

Add PyPI metadata to CLI package#1641

Merged
aliasaria merged 11 commits intomainfrom
add/cli-pypi-metadata
Mar 25, 2026
Merged

Add PyPI metadata to CLI package#1641
aliasaria merged 11 commits intomainfrom
add/cli-pypi-metadata

Conversation

@aliasaria
Copy link
Copy Markdown
Member

Summary

  • Add PyPI-required metadata to cli/pyproject.toml: authors, license (Apache-2.0), readme, classifiers, and [project.urls] with homepage and repository links.
  • Update cli/README.md with install instructions (uv tool install transformerlab-cli) and a description suitable for the PyPI page.

Test plan

  • Verify uv build succeeds in cli/ directory
  • Verify metadata appears correctly with uv publish --dry-run or twine check

Add authors, license, readme, classifiers, and project URLs to
cli/pyproject.toml. Update CLI README with install instructions
and a proper description for the PyPI page.
@paragon-review
Copy link
Copy Markdown

Paragon Summary

This pull request review identified 3 issues across 1 category in 2 files. The review analyzed code changes, potential bugs, security vulnerabilities, performance issues, and code quality concerns using automated analysis tools.

This PR prepares the CLI package for PyPI publication by adding required metadata fields (authors, license, classifiers, project URLs) to pyproject.toml and updating the README with installation instructions. The changes enable proper package distribution through PyPI.

Key changes:

  • Added PyPI metadata to cli/pyproject.toml: authors, Apache-2.0 license, readme, classifiers, and project URLs
  • Updated cli/README.md with uv tool install instructions and PyPI page description
  • No code changes - purely metadata/documentation for PyPI publishing readiness

Confidence score: 5/5

  • This PR has low risk with no critical or high-priority issues identified
  • Score reflects clean code review with only minor suggestions or no issues found
  • Code quality checks passed - safe to proceed with merge

2 files reviewed, 3 comments

Severity breakdown: Low: 3


Tip: @paragon-run <instructions> to chat with our agent or push fixes!

Dashboard

## Install

(install instructions coming soon, for now follow Build Locally instructions below)
```bash
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: Install docs reference PyPI before the package is confirmed published

Install docs reference PyPI before the package is confirmed published. Users following the README after merge will hit package-not-found errors. Gate the install line with a note until the package is live.

View Details

Location: cli/README.md (lines 11)

Analysis

Install docs reference PyPI before the package is confirmed published

What fails The PR test plan only verifies 'uv build succeeds' and 'uv publish --dry-run' with no actual publish step, yet the README documents the install command as if the package is already on PyPI.
Result uv tool install transformerlab-cli fails with package-not-found error
Expected Install instructions should only be documented after the package is verified live on PyPI, or include a note that it is available after the first release.
Impact Any user following the README immediately after merge will hit a hard failure on the install step.
How to reproduce
1. Merge this PR
2. Follow README install instructions: `uv tool install transformerlab-cli`
3. Observe failure if package is not yet published to PyPI
Patch Details
-uv tool install transformerlab-cli
+uv tool install transformerlab-cli  # Available after first PyPI release
AI Fix Prompt
Fix this issue: Install docs reference PyPI before the package is confirmed published. Users following the README after merge will hit package-not-found errors. Gate the install line with a note until the package is live.

Location: cli/README.md (lines 11)
Problem: The PR test plan only verifies 'uv build succeeds' and 'uv publish --dry-run' with no actual publish step, yet the README documents the install command as if the package is already on PyPI.
Current behavior: uv tool install transformerlab-cli fails with package-not-found error
Expected: Install instructions should only be documented after the package is verified live on PyPI, or include a note that it is available after the first release.
Steps to reproduce: 1. Merge this PR
2. Follow README install instructions: `uv tool install transformerlab-cli`
3. Observe failure if package is not yet published to PyPI

Provide a code fix.


Tip: Reply with @paragon-run to automatically fix this issue

@aliasaria aliasaria merged commit b49c70b into main Mar 25, 2026
5 checks passed
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