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

source for napari plugin description? #8

Closed
neuromusic opened this issue Apr 12, 2021 · 0 comments
Closed

source for napari plugin description? #8

neuromusic opened this issue Apr 12, 2021 · 0 comments

Comments

@neuromusic
Copy link
Collaborator

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?

This was referenced Apr 12, 2021
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

1 participant