8000 Fix license field of pyproject to follow PEP 621 by hegde-chan · Pull Request #193 · chonkie-inc/chonkie · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix license field of pyproject to follow PEP 621 #193

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix license field of pyproject to follow PEP 621 #193

wants to merge 2 commits into from

Conversation

hegde-chan
Copy link

Got the following error when attempting to run the pip inststall -e ".[dev]" command:

(venv) (base) chandanhegde@Chandans-MacBook-Pro:~/Desktop/Developer/chonkie$ pip install -e ".[dev]"
Obtaining file:///Users/chandanhegde/Desktop/Developer/chonkie
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... error
  error: subprocess-exited-with-error
  
  × Getting requirements to build editable did not run successfully.
  │ exit code: 1
  ╰─> [95 lines of output]
      Compiling src/chonkie/chunker/c_extensions/split.pyx because it depends on /private/var/folders/x7/ts3hb0pn59zc25x0hwyk7zx00000gn/T/pip-build-env-6e8asw34/overlay/lib/python3.8/site-packages/Cython/Includes/cpython/type.pxd.
      Compiling src/chonkie/chunker/c_extensions/merge.pyx because it depends on /private/var/folders/x7/ts3hb0pn59zc25x0hwyk7zx00000gn/T/pip-build-env-6e8asw34/overlay/lib/python3.8/site-packages/Cython/Includes/libc/stdlib.pxd.
      [1/2] Cythonizing src/chonkie/chunker/c_extensions/merge.pyx
      [2/2] Cythonizing src/chonkie/chunker/c_extensions/split.pyx
      configuration error: `project.license` must be valid exactly by one definition (2 matches found):
      
          - keys:
              'file': {type: string}
            required: ['file']
          - keys:
              'text': {type: string}
            required: ['text']
      
      DESCRIPTION:
          `Project license <https://peps.python.org/pep-0621/#license>`_.
      
      GIVEN VALUE:
          "MIT"
      
      OFFENDING RULE: 'oneOf'
      
      DEFINITION:
          {
              "oneOf": [
                  {
                      "properties": {
                          "file": {
                              "type": "string",
                              "$$description": [
                                  "Relative path to the file (UTF-8) which contains the license for the",
                                  "project."
                              ]
                          }
                      },
                      "required": [
                          "file"
                      ]
                  },
                  {
                      "properties": {
                          "text": {
                              "type": "string",
                              "$$description": [
                                  "The license of the project whose meaning is that of the",
                                  "`License field from the core metadata",
                                  "<https://packaging.python.org/specifications/core-metadata/#license>`_."
                              ]
                          }
                      },
                      "required": [
                          "text"
                      ]
                  }
              ]
          }

This change was able to fix it. It seems like this PEP: https://peps.python.org/pep-0621/#license, expects the license field to be a "Table" (JSON object).

gemini-code-assist[bot]
gemini-code-assist bot reviewed Jun 16, 2025
View reviewed changes
Copy link
Contributor
@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @hegde-chan, 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 a build/installation error encountered when trying to install the project in editable mode. The issue stemmed from the license field in pyproject.toml not adhering to the structure required by PEP 621. The change modifies this field to the correct format, resolving the installation problem.

Highlights

  • Configuration Fix: Updated the license field in pyproject.toml to comply with PEP 621, changing it from a simple string to a table format { text = "..." }.
Using Gemini Code Assist

The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and 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 to provide feedback.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

greptile-apps[bot]
greptile-apps bot reviewed Jun 16, 2025
View reviewed changes
Copy link
Contributor
@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Updates the license field in pyproject.toml to comply with PEP 621 specification, changing it from a simple string 'MIT' to a proper table format { text = 'MIT' } to resolve pip installation errors.

  • Fixed invalid license field format in pyproject.toml that was causing editable install failures due to PEP 621 compliance issues

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

gemini-code-assist[bot]
gemini-code-assist bot reviewed Jun 16, 2025
View reviewed changes
Copy link
Contributor
@gemini-code-assist gemini-code-assist bot left a 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 effectively resolves a build failure encountered during editable installs (pip install -e ".[dev]") by ensuring the license field in pyproject.toml adheres to PEP 621. The modification from license = "MIT" to license = { text = "MIT" } correctly uses the table format required by the specification, which is a crucial fix for the project's packaging and development workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hegde-chan @chonknick
0