Skip to content

Dynamically generate plugins table with sortable columns #11232

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

Open
The-Compiler opened this issue Jul 19, 2023 · 5 comments
Open

Dynamically generate plugins table with sortable columns #11232

The-Compiler opened this issue Jul 19, 2023 · 5 comments
Labels
type: docs documentation improvement, missing or needing clarification type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature

Comments

@The-Compiler
Copy link
Member

With almost 1300 plugins in the plugin list, it's pretty much impossible to browse through it... you can search for things if you know what you're looking for, but it's impossible to really find anything new. There are just too many plugins there which happen to be on PyPI but aren't really meant for public usage; or e.g. various joke plugins (I'm guilty of that one!).

Someone at Europython 2023 proposed to me that we sort it by popularity instead. I feel like it's a good idea! I recognize the downside that it makes it even harder for unpopular plugins to gain popularity, but then again, that seems better than making it harder for plugins that start with a z...

To get the data, we could use the PyPI Stats API - or perhaps, if 1300 plugins is too big of a hit against that, query the data ourselves. I suppose the latter would be preferrable.

If people don't object to this, and someone at Europython 2023 wants to pair up at the Sprints to give this a try (newcomers very much welcome!), let me know.

@The-Compiler The-Compiler added type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature type: docs documentation improvement, missing or needing clarification labels Jul 19, 2023
@RonnyPfannschmidt
Copy link
Member

I'm all for it, but I'd like to merge my cache pr for the script first

@nicoddemus
Copy link
Member

Yeah, sounds like a good idea. 👍

@RonnyPfannschmidt
Copy link
Member

i refreshed #10927 - lets merge it once green so people can base on it

@nicoddemus
Copy link
Member

Done! 👍

@The-Compiler
Copy link
Member Author

Another more sophisticated idea: What if we had a plugins.json somewhere, and used JS to generate the table dynamically? Then people could change the sorting columns as they please. We could also always use the plugins.json from main even if someone is looking at the docs in a stable branch.

We could even still keep the statically generated page as a fallback, and then with JS remove the content and update it by the dynamic one.

@Zac-HD Zac-HD changed the title Sorting plugin list by popularity? Dynamically generate plugins table with sortable columns Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature
Projects
None yet
Development

No branches or pull requests

3 participants