You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Nearly all napari plugins have a PyPI description sourced from their Github README, however we would like to let plugin developers provide a description of their plugin tailored to napari hub users.
This is especially important for plugins that are offered as general purpose Python packages... These will likely will want to have distinct intros, descriptions, and usage guidance for different platforms and audiences so as not to confuse users.
The proposed source of this napari-specific description would be a markdown file in the plugin developer's code repository.
For example...
NAPARI.md in the top level of the repo
There is other metadata that we'd like to let plugin developers control independently of fields in PyPI as well, including author information and (eventually) tags or categories.
In this case, it might be better to define a hidden folder for napari config info (.napari/) then put the description in there, along with any other config files...
.napari/DESCRIPTION.md
.napari/README.md
Thoughts?
The text was updated successfully, but these errors were encountered:
Nearly all napari plugins have a PyPI description sourced from their Github README, however we would like to let plugin developers provide a description of their plugin tailored to napari hub users.
This is especially important for plugins that are offered as general purpose Python packages... These will likely will want to have distinct intros, descriptions, and usage guidance for different platforms and audiences so as not to confuse users.
The proposed source of this napari-specific description would be a markdown file in the plugin developer's code repository.
For example...
NAPARI.md
in the top level of the repoThere is other metadata that we'd like to let plugin developers control independently of fields in PyPI as well, including author information and (eventually) tags or categories.
In this case, it might be better to define a hidden folder for napari config info (
.napari/
) then put the description in there, along with any other config files....napari/DESCRIPTION.md
.napari/README.md
Thoughts?
The text was updated successfully, but these errors were encountered: