search

siesta-project / aiida_siesta_plugin

Source code for the AiiDA-Siesta package (plugin and workflows). See wiki
Other
6 stars 11 forks source link

PyPI resubmission minor edit #19

Closed vdikan closed 5 years ago

vdikan commented 5 years ago

The plugin package is resubmitted to PyPI: https://pypi.org/project/aiida-siesta/

I had to make small edits for the description of the build. It shows logos on both git and pypi, and adds additional files for tests subfolder.

This solves the issue.

albgar commented 5 years ago

@vdikan Thanks, Vladimir, but I do not understand the changes to README.rst. When considered within the GitHub tree itself they do not make much sense. Perhaps I do not understand the way in which the PyPi package is uploaded.

vdikan commented 5 years ago

@albgar PyPI does not follow a folder structure of a package, it seems to only read README file for Project description. This way the logos are broken on PyPI page https://pypi.org/project/aiida-siesta/ . Workaround: I used full github url to "raw" files as a hosting place.

albgar commented 5 years ago

OK, but the README.rst file is also used for the Github front page, and I would not like to include meta-references to github in it. I would rather try (if it works), shipping the figures explicitly with the package. Something like this extra line in the manifest file:

recursive-include aiida_siesta/docs/miscellaneous/ *.png

albgar commented 5 years ago

Or else, see if the "project description" in PyPi can be built in some other way (maybe with a user-defined name for the main .rst file). Then we can have the same content as in README.rst, but without the figures, which are not important in PyPi.

vdikan commented 5 years ago

I chose the second option, since pypi.org does not host static files for project description. Moreover, if you address external image sources, it will rescale them and that looks ugly. The pypi.org long_description points to PyPI-README.rst, while git uses old README.rst by default. Version number is incremented, because pypi.org demands to do it with every submission.