Skip to content

Remove newlines from description / Fix summary. #626

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

Merged
merged 1 commit into from
Nov 23, 2023

Conversation

micwoj92
Copy link
Contributor

When trying to build wheel it gives warning

writing msal.egg-info/PKG-INFO
/usr/lib/python3.11/site-packages/setuptools/dist.py:173: SetuptoolsDeprecationWarning: Invalid config.
!!

        ********************************************************************************
        newlines are not allowed in `summary` and will break in the future
        ********************************************************************************

!!
  write_field('Summary', single_line(summary))

This can be seen in latest wheel on pypi msal-1.25.0-py2.py3-none-any.whl
summary field in METADATA file is incomplete, it only states:
Summary: The Microsoft Authentication Library (MSAL) for Python library

@rayluo
Copy link
Collaborator

rayluo commented Nov 18, 2023

Thanks for bringing this to our attention.

Out of curiosity, why would you need to build a wheel (thus run into this issue) in the first place? I believe a standard pip install msal will already install a wheel that we already build for you.

@micwoj92
Copy link
Contributor Author

The issue (description being cut after first newline) is also present in the wheel.

@rayluo
Copy link
Collaborator

rayluo commented Nov 23, 2023

The issue (description being cut after first newline) is also present in the wheel.

True, and your finding was legit.

I was just curios to know that in what scenario you would need to build a wheel from source. Most people just pip install an already-built wheel, and would not even notice that issue.

Regardless, this PR will be kept open for one more day, in case you would like to reply back. We will merge this PR afterwards.

@micwoj92
Copy link
Contributor Author

I was just curios to know that in what scenario you would need to build a wheel from source. Most people just pip install an already-built wheel, and would not even notice that issue.

This module is available in AUR. The package builds python-msal from source.

@rayluo rayluo merged commit 6b162da into AzureAD:dev Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants