Skip to content
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

Readme file too long for Azure Artifacts #209

Open
arturosevilla opened this issue Dec 19, 2023 · 6 comments
Open

Readme file too long for Azure Artifacts #209

arturosevilla opened this issue Dec 19, 2023 · 6 comments

Comments

@arturosevilla
Copy link

I get the following error when I'm trying to setup through Azure Artifacts a project with linguage-language-detector as a dependency: The package description exceeds the maximum length of 349608 bytes

The reason, as stated, is that the package description is huge (the entire README.md file is part of the package description through the readme.

Is there a way to only have a summary of such README.md in to the package description?

@pemistahl
Copy link
Owner

Hi Arturo, thanks for reaching out to me.

Is there a way to only have a summary of such README.md in to the package description?

I don't know whether Azure Artifacts allows to exclude or shrink the README. Can't you simply remove the README from the artifact on Azure? The problem probably occurs because of the large accuracy table I've included in the README. I could put the table in a separate file but actually I want to avoid that so that the table is available on PyPI as well.

@arturosevilla
Copy link
Author

arturosevilla commented Dec 19, 2023

As far as I know, you cannot modify packages coming from upstream (PyPI). The scenario is that if we have a private repo (setup with extra-index-url in pip.ini), and there are some artifacts/packages that are dependent on lingua-language-detector then pip will try to restore the packages through Azure Artifacts. However, because of the aforementioned error, it will fail when being retrieved from upstream as the description is too big for Artifacts.

Also, setting up bothextra-index-url and/or index-url does not guarantee any order: https://stackoverflow.com/questions/67253141/python-pip-priority-order-with-index-url-and-extra-index-url

Other packages have had this issue before, and basically the solution is to reduce the package description:

@pemistahl
Copy link
Owner

Ok, I will put the table in a separate file when I prepare the next release. But I won't make a new release just for the sake of the readme. So you will have to wait until the next regular release. I hope you understand.

@pemistahl pemistahl changed the title Incompatible with Azure Artifacts Readme file too long for Azure Artifacts Dec 21, 2023
@pemistahl pemistahl added this to the Lingua 2.1.0 milestone Dec 21, 2023
@arturosevilla
Copy link
Author

Of course. I just wanted it bring this to attention. In fact, I believe Azure Artifacts is going against the standard, but I do understand they want to impose certain limits.

@diwakar-vsingh
Copy link

Hi Peter, is there any update on this as I'm running into the exact same error that Arturo was running into?

@pemistahl
Copy link
Owner

pemistahl commented May 2, 2024

@diwakar-vsingh Not yet, unfortunately. I've been busy with my daily job and family life, so I could not continue the development of my library yet. There will be updates for sure, but I cannot tell you when right now.

@pemistahl pemistahl modified the milestones: Lingua 2.1.0, Lingua 1.4.0 Aug 14, 2024
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

No branches or pull requests

3 participants