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

Comment out the project URLs configured in setup.cfg #15

Open
DragaDoncila opened this issue Jul 14, 2022 · 5 comments
Open

Comment out the project URLs configured in setup.cfg #15

DragaDoncila opened this issue Jul 14, 2022 · 5 comments
Labels
good first issue Good for newcomers

Comments

@DragaDoncila
Copy link
Contributor

In napari/cookiecutter-napari-plugin#32 we added defaults for project URLs in setup.cfg. We've since had some feedback that developers don't really know where that information comes from on the napari hub, and how to change it. At the very least, we should comment out these URLs so that plugins don't show information that hasn't been explicitly exposed by the plugin developer.

@DragaDoncila DragaDoncila added the good first issue Good for newcomers label Jul 14, 2022
@Czaki
Copy link
Contributor

Czaki commented Jul 14, 2022

I rather prefer to add some detailed documentation than remove this. This is one of the core python packaging features.

@DragaDoncila
Copy link
Contributor Author

@Czaki I agree that it's a core feature and we should encourage people to provide these URLs - I added them in the first place! However, what we're finding is that people are not aware of these URLs, and they're not editing them. This is despite clear instructions after creation that you should go and edit these. So I don't think it's a matter of more detailed documentation.

My hope is that we can move more towards conscious and explicit actions from developers to provide appropriate metadata and documentation for their plugins, rather than us providing them with default values. By commenting these values out, developers will be alerted to this lack of metadata on the PyPI project page, their napari hub plugin page and the napari hub preview page. This will allow them to go and make the conscious choice of adding these URLs back in, and considering where they point to, rather than having "complete" metadata they are unaware of.

@brisvag
Copy link
Contributor

brisvag commented Jul 17, 2022

Good point @DragaDoncila, if this comes with a "plugin completeness" warning of some sort from the hub, I agree with commenting them out.

@Czaki
Copy link
Contributor

Czaki commented Jul 17, 2022

developers will be alerted to this lack of metadata on the PyPI project page

I worry that they will not notice this. But in general I agree with @brisvag that with Warning on napari hub it may be enough.

@jni jni transferred this issue from napari/cookiecutter-napari-plugin Aug 5, 2024
@jni
Copy link
Member

jni commented Aug 5, 2024

The relevant lines in the template are now in the pyproject.toml:

[project.urls]
"Bug Tracker" = "https://github.com/{{github_username_or_organization}}/{{plugin_name}}/issues"
"Documentation" = "https://github.com/{{github_username_or_organization}}/{{plugin_name}}#README.md"
"Source Code" = "https://github.com/{{github_username_or_organization}}/{{plugin_name}}"
"User Support" = "https://github.com/{{github_username_or_organization}}/{{plugin_name}}/issues"

I think that these are ok actually, especially since we have a conditional now. Now that we are actively aiming to simplify the hub's implementation, I think that we should solve this issue with documentation, not by turning off this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants