Search code examples
pythonpypipython-poetry

Only update readme for a package on PyPI

I published a package on PyPI and then realised I should change a few details in the attached README.md. Is it possible to change the readme without uploading a new version of the whole package? And if not, what is the most correct way to update the README on PyPI?

I am using poetry to manage the package, and when I change README and run poetry publish --build, there is an error, because PyPI does not allow re-uploading a file with an already used name.

It seems like only changing the documentation should be a possibility, as, e.g., writing some extra help or changing a contact should not require a whole round of changing version and testing that everything still works?

Solution

  • Unfortunately, no it isn't, because when you go to publish, the versions are immutable. This is by design. My suggestion would be to increment a minor version z on x.y.z in order to publish the latest version with updates to the README.

    So something like: 0.0.9 -> 0.0.10 or 2.1.0 -> 2.1.1