search

pemistahl / lingua-py

The most accurate natural language detection library for Python, suitable for short text and mixed-language text
Apache License 2.0
1.02k stars 43 forks source link

Readme file too long for Azure Artifacts #209

Open arturosevilla opened 7 months ago

arturosevilla commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

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 commented 6 months ago

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.

arturosevilla commented 6 months ago

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 commented 2 months ago

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

pemistahl commented 2 months ago

@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.