syndication icon indicating copy to clipboard operation
syndication copied to clipboard

[WIP] Common feed format

Open porglezomp opened this issue 8 years ago • 10 comments

This is a first attempt at defining a common structure for both Atom and RSS feeds. It's not complete yet, and it doesn't provide the best round trip guarantees right now. Feedback is very much appreciated.

In addition to looking at the docs for both atom_syndication and rss, the information at RSS and Atom Compared has been extremely helpful while implementing this.

porglezomp avatar Jun 13 '16 01:06 porglezomp

Do we want to expose only the common format as the public API?

porglezomp avatar Jun 13 '16 02:06 porglezomp

Thanks for the contribution!

We should only expose the common format as the public API. The purpose of this library is to define a common format so that you can use the same code for working on both Atom and RSS feed, but I just never got around to finishing it. Exposing the Atom/RSS library-specific formats defeats that purpose.

I'll try to take a look at the code sometime this week.

tomshen avatar Jun 13 '16 14:06 tomshen

Right now I'm considering doing

use atom_syndication as atom;

since it gives better symmetry with rss, and it's less annoying since I have to disambiguate the types a lot in some of the modules. Is this okay, or should I avoid this?

porglezomp avatar Jun 15 '16 00:06 porglezomp

That looks fine to me.

tomshen avatar Jun 15 '16 00:06 tomshen

There aren't very good tests for this library, are there. Trying to write some, I guess I can see why. Any ideas for what I should do on the testing front?

porglezomp avatar Jun 15 '16 19:06 porglezomp

Should I put myself as an author?

porglezomp avatar Jun 15 '16 19:06 porglezomp

There aren't very good tests for this library, are there. Trying to write some, I guess I can see why. Any ideas for what I should do on the testing front?

You could use tests from other open source libraries. e.g. https://github.com/kurtmckee/feedparser/tree/develop/tests

Should I put myself as an author?

Definitely, especially since after this PR merges, most of the codebase will be your work.

Honestly, I haven't looked at Rust stuff in a really long time. So if you want, I can just transfer ownership of the repo/crate to you.

tomshen avatar Jun 15 '16 23:06 tomshen

I just finished up classes for the year, and I accidentally broke my main RSS reader, so I figure now's a good time to come back to this. I'm going to try to use this to build a small feed reader in order to figure out if the API has any glaring holes.

porglezomp avatar Apr 21 '17 20:04 porglezomp

Hi, is there still motivation for this? I'm currently writing an application that requires unified RSS & Atom parsing, this would be a great help. Willing to pick it up if there's no time for this on your side.

nc7s avatar Feb 02 '24 04:02 nc7s

My job means I'm currently not able to easily make open source contributions, I would be happy with someone else picking up the work.

porglezomp avatar Feb 02 '24 07:02 porglezomp