How to specify a proprietary license?

[mvtec-bergdolll]

We are migrating from setuptools to hatchling, what would be appropriate translation from:

license='Other/Proprietary License see eula.html',
data_files=[('', ['eula.html'])],

To pyproject.toml entries?

[ischaojie]

[project]
...
license = "Other/Proprietary License see eula.html"

...
[tool.hatch.build.targets.wheel.shared-data]
"eula.html" = "/eula.html"

if you run hatch new --init in your project, hatch will auto-migrate it.

[wshanks]

This doesn't work for me. I get

        ...
        File "/tmp/pip-build-env-ad4h8mxd/overlay/lib/python3.11/site-packages/hatchling/build.py", line 78, in build_editable
          return os.path.basename(next(builder.build(wheel_directory, ['editable'])))
                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-ad4h8mxd/overlay/lib/python3.11/site-packages/hatchling/builders/plugin/interface.py", line 93, in build
          self.metadata.validate_fields()
        File "/tmp/pip-build-env-ad4h8mxd/overlay/lib/python3.11/site-packages/hatchling/metadata/core.py", line 244, in validate_fields
          self.core.validate_fields()
        File "/tmp/pip-build-env-ad4h8mxd/overlay/lib/python3.11/site-packages/hatchling/metadata/core.py", line 1325, in validate_fields
          getattr(self, attribute)
        File "/tmp/pip-build-env-ad4h8mxd/overlay/lib/python3.11/site-packages/hatchling/metadata/core.py", line 658, in license
          raise ValueError(message) from None
      ValueError: Error parsing field `project.license` - invalid license expression: Other/Proprietary License see eula.html
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.

[studioj]

hatchling only supports following licenses:
https://github.com/pypa/hatch/blob/master/backend/src/hatchling/licenses/supported.py#L5

having no license is actually an "all rights reserved" but maybe it could be made implicitly available?

[studioj]

another way is seemingly this https://github.com/pypa/hatch/pull/451/files#diff-e08b163c653d9841b00b690b855bb5a4c4db827f347ad0d775381649d85f7246R11

that worked for me

[nicc777]

The only practical way I found to deal with this is to not include license = ... but only define the license-files = ["LICEN[CS]E*"] and then have the unsupported or proprietary license definition in the LICENSE file

[wshanks]

The code related to the handling of project.license has changed since this discussion first started. Now, hatchling passes any string through as a license identifier as long as it starts with LicenseRef-. The behavior changed with hatchling 1.26. The change comes from #1788. That change switched from using custom code in hatchling for matching the license expression to using normalize_license_expression from pypa/packaging 24.2. Prior to the change the hatchling code would match to SPDX identifiers or the special cases of LicenseRef-Public-Domain and LicenseRef-Proprietary as referenced in this comment above. Allowing any license identifier starting with LicenseRef- is mentioned in PEP639.

[nicc777]

Thanks - I tested with the license = "LicenseRef-Proprietary" and it works.