Similar plugin

[ashwinvis]

This plugin is very similar to:

• https://framagit.org/bochecha/pelican-planet

which I forked recently and added async functionality to in:

• https://github.com/ashwinvis/pelican-planet

There may be ideas in the implementation of pelican-planet which could be useful for webring.

[davidag]

Thank you for letting us know about that plugin and your async implementation! They really look similar! 😅

I'll try to review both and compare features (at first sight, it looks like there are some important differences). Maybe we could merge them in one plugin supporting all use cases (shouldn't be too many), what do you think @ashwinvis ?

[ashwinvis]

That sounds like a great idea 👍. I think it should be done incrementally. If I may propose:

1. Could you structure the plugin using a class, rather than using module level globals. Also the __init__.py can take care of registering the plugin and parsing the config variables. This is what was done in pelican-planet.
2. I can convert the function

webring/pelican/plugins/webring/webring.py

Line 82 in 8121b14

def get_feed_html(feed_url):

into something like https://github.com/ashwinvis/pelican-planet/blob/4c90e8e66c277774b841c38a01e062cc7a17bd44/pelican_planet/planet.py#L57-L102

3. Combine the modules

[davidag]

Great information @ashwinvis, I'd like to understand first the high level differences and then plan how to implement the differences.

I think it's important to try to keep the configuration as equivalent as possible, to ease any migration between plugins. Also, I think it's better to improve webring than planet because it already has a repo in pelican-plugins and the name seems more descriptive, in my opinion.

About your proposal:

• I'm not sure having a class is necessary when there is no inheritance, nor the object will be instantiated more than once. I think a module is good enough in this case.
• I'm no asyncio expert, so I think your plugin can be of great use there. By the way, have you noticed any speed improvement?

Thanks!

[ashwinvis]

I'm not sure having a class is necessary when there is no inheritance, nor the object will be instantiated more than once. I think a module is good enough in this case.

It was useful for testing with different parameters (https://framagit.org/bochecha/pelican-planet/-/blob/master/pelican_planet/tests/test_planet.py).

I'm no asyncio expert, so I think your plugin can be of great use there. By the way, have you noticed any speed improvement?

Substantial!