-
Notifications
You must be signed in to change notification settings - Fork 0
[PD1-323] Add license-files metadata for PyPI #19
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
Conversation
PD1-323 Standardize Python repos to use mypy and ruff
Standardize on Python 14. TensorFlow projects may need to use Python 13, instead. Ruff replaces several linters and formatters:
Change: |
Summary of ChangesHello @joshuanapoli, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses an issue where the package's MIT license was not being properly recognized on PyPI. It resolves this by explicitly adding the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly adds the license-files metadata to pyproject.toml, which will ensure the license is properly recognized by PyPI and included in the package distributions. The version bump is also appropriate for this change. While the change itself is correct, I've identified a significant structural issue in pyproject.toml regarding dependency management with Poetry, which could impact project maintainability and the developer setup experience. I have left a detailed comment on this matter.
| "pyarrow>=22.0.0", | ||
| ] | ||
| license = "MIT" | ||
| license-files = ['LICENSE'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this line correctly adds the license file to the package metadata, I've noticed a larger structural issue in this file. The project is configured to use Poetry as its build backend, but the dependencies are declared under the [project] table.
Poetry's dependency management tools (e.g., poetry install, poetry add) do not use the [project.dependencies] field. They expect dependencies to be defined in [tool.poetry.dependencies]. This discrepancy can lead to an inconsistent or broken development environment, as developers using Poetry commands won't have the correct dependencies installed.
To ensure project maintainability and a consistent developer experience, I strongly recommend moving the dependencies to the [tool.poetry] section in a follow-up change. You would remove the dependencies and requires-python keys from [project] and create a [tool.poetry.dependencies] section like this:
[tool.poetry.dependencies]
python = ">=3.10"
pydantic = ">=2.12.0"
pyarrow = ">=22.0.0"
alok27a
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM!
Set all the metadata, in order to actually recognize the package as MIT-licensed.
Testing
License-checking passed.