Package update feed #2165

AyumuKasuga · 2017-07-02T23:56:26Z

Fixes #2551, fixes #1683.
Url like /rss/{package_name}/updates.xml with last 10 releases.

I hope it solves pypi#1683 issue. Url like `/rss/{package_name}/updates.xml` with last 10 releases.

nlhkabu · 2017-07-25T20:46:19Z

Hi @AyumuKasuga - thanks for this PR.
Can you please provide a screenshot of each of the template updates so I can validate? Thanks

AyumuKasuga · 2017-07-26T06:05:36Z

Hi @nlhkabu
There is no visual changes in templates in this PR, it's only adds <link> tag in template here

And RSS feed is just xml like this:

di · 2017-07-26T15:08:05Z

warehouse/templates/rss/project_updates.xml

@@ -0,0 +1,14 @@
+{% extends "base.xml" %}
+{% block title %}Recent Updates of {{ project_name }} package{% endblock %}
+{% block description %}Recent Updates of {{ project_name }} to the Python Package Index{% endblock %}


It might be better if this title and description said something like "Latest releases of the {{ project_name }} package".

At the very least, this should say "updates to the {{ project_name }} package" instead of "updates of {{ project_name }} package"

di · 2017-07-26T15:08:35Z

warehouse/templates/packaging/detail.html

@@ -56,6 +56,10 @@ <h3 class="package-snippet__title">

 {% block description %}{{ release.summary }}{% endblock %}

+{% block extra_rss %}
+  <link rel="alternate" type="application/rss+xml" title="RSS: updates of {{ release.project.normalized_name }}" href="{{ request.route_path('rss.project_updates', name=release.project.normalized_name) }}">


Same comment here about "updates of".

di · 2017-07-26T15:18:51Z

warehouse/rss/views.py

+    )
+
+    if not latest_releases:
+        return HTTPNotFound()


I think there's a difference here between the case when project hasn't been registered yet, and the case when the project exists, but doesn't have any releases.

For the former, I would expect a 404, but for the latter, I would expect an RSS feed with no <item>s.

This would be handled by using traverse as mentioned in my other comment.

di · 2017-07-26T15:20:49Z

tests/unit/test_routes.py

@@ -141,6 +141,8 @@ def add_policy(name, filename):
            "https://files.example.com/packages/{path}",
        ),
        pretend.call("rss.updates", "/rss/updates.xml", domain=warehouse),
+        pretend.call("rss.project_updates",
+                     "/rss/{name}/updates.xml", domain=warehouse),


If you set the following:

traverse="/{name}", factory="warehouse.packaging.models:ProjectFactory",

you can expect a project argument to the rss_project_updates function, and a query will be unnecessary. This will also handle 404-ing if the project doesn't exist.

di · 2017-07-26T15:22:49Z

warehouse/rss/views.py

+    return {
+        "project_name": project_name,
+        "latest_releases": latest_releases
+    }


If we made the necessary changes to get a project via the ProjectFactory, we could just pass the project variable to the template here, and use project.name and project.releases (which is ordered by creation date) directly in the template.

AyumuKasuga · 2017-07-26T20:36:36Z

Hello @di
Thanks for the review. I changed templates and improved project_updates view using ProjectFactory

…e into package_update_feed

di · 2017-07-27T15:23:43Z

warehouse/templates/rss/project_updates.xml

@@ -0,0 +1,14 @@
+{% extends "base.xml" %}
+{% block title %}Latest releases of the {{ project.name }} package{% endblock %}


Nitpick: this should probably say "project", not package. It would be good to put the project name in quotes too.

di · 2017-07-27T15:24:00Z

warehouse/templates/rss/project_updates.xml

@@ -0,0 +1,14 @@
+{% extends "base.xml" %}
+{% block title %}Latest releases of the {{ project.name }} package{% endblock %}
+{% block description %}Latest releases of the {{ project.name }} to the Python Package Index{% endblock %}


Same here, let's add quotes and "project".

PR pypi#2165

AyumuKasuga · 2017-07-27T19:33:20Z

@di thanks, fixed!

di

LGTM 👍

jakirkham · 2017-09-17T18:25:45Z

Anything else needed for this PR? Seems very useful (though I'm biased 😄).

rce · 2018-02-02T14:34:27Z

Hello @di! Is there something preventing merge and can I do something to make it happen?

di · 2018-02-02T19:53:22Z

Yes, sorry for not following up. I had some reservations about this after approving, but haven't had a chance to address them (my time has mostly been spent in favor of development which helps fully us transition from pypi-legacy to Warehouse), so this PR has been on the backburner.

One thing: I wanted to check/ensure that this view is either not cached, or purged when a new release is made.

Another thing is that right now it's possible to delete releases (via pypi-legacy, and soon via Warehouse as well) and it would be ideal to have an entry in this feed for when a release is deleted as well. As it stands right now, the feed introduced by this PR just shows all the existing releases for a project. It might make more sense to look at the Journal entries for a project instead, which would include new releases and deletions.

I don't really want to start @AyumuKasuga off on revising this PR until I've really had a chance to think about it again (and other PyPI maintainers have weighed in) but perhaps they could do a little investigation of those ideas and report back.

Still have some things to figure out.

brainwane · 2018-02-05T20:34:11Z

I'm also sorry for the slow response!

To second Dustin: The folks working on Warehouse have gotten funding to concentrate on improving and deploying Warehouse, and have kicked off work towards our development roadmap -- the most urgent task is, as Dustin said, to improve Warehouse to the point where we can redirect pypi.python.org to pypi.org so the site is more sustainable and reliable. Since this feature isn't something that the legacy site has, I've moved it to a future milestone. But Dustin, Ernest, and other developers are interested in giving @AyumuKasuga feedback as they proceed, here or in IRC.

@di mentioned that the right approach might be to provide a feed of Journal updates -- @AyumuKasuga, you should check out #2871 to see that work progress, and maybe build on that!

Thanks and sorry again for the wait.

brainwane · 2018-03-08T13:10:59Z

@AyumuKasuga Now that #2871 is finished, would you like to return to this PR and talk with us about how to proceed? Perhaps using the Journal entries?

As always, if you have questions along the way as you work on this, please feel free to ask them here, in #pypa-dev on Freenode, or the pypa-dev mailing list. Thank you!

brainwane · 2018-04-18T18:09:23Z

@AyumuKasuga Ping :)

AyumuKasuga · 2018-04-18T18:25:08Z

@brainwane sorry, currently don't have time to work on this.

di · 2018-04-24T17:14:57Z

No worries @AyumuKasuga. Given that, I'm going to close this PR in favor of a different, yet-to-be-implemented API (see #284) which will ideally have the features I mentioned in #2165 (comment).

Anyone that was hoping for this to be merged: Feel free to file a new issue with your specific use-case and we can try to help you make do with the existing APIs (this will also help us consider your use-case when creating the new API).

AyumuKasuga added 2 commits July 3, 2017 02:46

Add package update RSS feed

de561fb

I hope it solves pypi#1683 issue. Url like `/rss/{package_name}/updates.xml` with last 10 releases.

Merge branch 'master' into package_update_feed

0b6699d

di reviewed Jul 26, 2017

View reviewed changes

AyumuKasuga added 3 commits July 26, 2017 21:49

Merge branch 'master' into package_update_feed

9fa944e

changes in templates for pypi#2165

d8b791b

improve rss.project_updates view. pypi#2165

a651185

AyumuKasuga added 3 commits July 27, 2017 00:06

Merge branch 'master' into package_update_feed

badbf1d

remove unused imports

c67418a

Merge branch 'package_update_feed' of github.com:AyumuKasuga/warehous…

9ac9786

…e into package_update_feed

di reviewed Jul 27, 2017

View reviewed changes

change title and description in rss template

3ea0c3e

PR pypi#2165

di previously approved these changes Jul 28, 2017

View reviewed changes

edmorley mentioned this pull request Nov 2, 2017

RSS feed for new file uploads to existing packages #2551

Open

Merge branch 'master' into package_update_feed

2b794a0

brainwane added this to the Cool but not urgent milestone Feb 5, 2018

di closed this Apr 24, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Package update feed #2165

Package update feed #2165

AyumuKasuga commented Jul 2, 2017 •

edited by di

Loading

nlhkabu commented Jul 25, 2017

AyumuKasuga commented Jul 26, 2017

di Jul 26, 2017

di Jul 26, 2017

di Jul 26, 2017

di Jul 26, 2017

di Jul 26, 2017

AyumuKasuga commented Jul 26, 2017

di Jul 27, 2017

di Jul 27, 2017

AyumuKasuga commented Jul 27, 2017

di left a comment

jakirkham commented Sep 17, 2017

rce commented Feb 2, 2018

di commented Feb 2, 2018

brainwane commented Feb 5, 2018

brainwane commented Mar 8, 2018

brainwane commented Apr 18, 2018

AyumuKasuga commented Apr 18, 2018 •

edited

Loading

di commented Apr 24, 2018

		@@ -0,0 +1,14 @@
		{% extends "base.xml" %}
		{% block title %}Latest releases of the {{ project.name }} package{% endblock %}

Package update feed #2165

Package update feed #2165

Conversation

AyumuKasuga commented Jul 2, 2017 • edited by di Loading

nlhkabu commented Jul 25, 2017

AyumuKasuga commented Jul 26, 2017

di Jul 26, 2017

Choose a reason for hiding this comment

di Jul 26, 2017

Choose a reason for hiding this comment

di Jul 26, 2017

Choose a reason for hiding this comment

di Jul 26, 2017

Choose a reason for hiding this comment

di Jul 26, 2017

Choose a reason for hiding this comment

AyumuKasuga commented Jul 26, 2017

di Jul 27, 2017

Choose a reason for hiding this comment

di Jul 27, 2017

Choose a reason for hiding this comment

AyumuKasuga commented Jul 27, 2017

di left a comment

Choose a reason for hiding this comment

jakirkham commented Sep 17, 2017

rce commented Feb 2, 2018

di commented Feb 2, 2018

brainwane commented Feb 5, 2018

brainwane commented Mar 8, 2018

brainwane commented Apr 18, 2018

AyumuKasuga commented Apr 18, 2018 • edited Loading

di commented Apr 24, 2018

AyumuKasuga commented Jul 2, 2017 •

edited by di

Loading

AyumuKasuga commented Apr 18, 2018 •

edited

Loading