Add GitLab Statistics #4384

am-on · 2018-07-28T15:01:55Z

Added star and fork statistics on detailed project view for projects with an
valid GitLab URL.

am-on · 2018-07-28T15:02:42Z

di · 2018-07-28T15:24:09Z

warehouse/packaging/models.py

@@ -413,6 +413,18 @@ def github_repo_info_url(self):
                user_name, repo_name = segments[:2]
                return f"https://github.com/api/repos/{user_name}/{repo_name}"

+    @property
+    def gitlab_repo_info_url(self):
+        # import pdb; pdb.set_trace()


Comment left behind here.

nlhkabu · 2018-07-28T15:28:29Z

As discussed at the sprints with @am-on, I would like to know if it's possible to use a macro for the links, e.g. moving this code into a macro:

<a class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--condensed gitlab-repo-info__item"
   data-key="html_url" data-attr="href" data-supplement="/network" rel="noopener"
   target="_blank">
  <i class="fa fa-code-branch" aria-hidden="true"></i>
  <strong>Forks: </strong>
  <span class="gitlab-repo-info__item" data-key="forks_count"></span>
</a>

di · 2018-07-28T15:33:26Z

We could also probably make that section more generic, since it's unlikely that a project has both GitHub and gitlab links.

Also, we should probably prefer one over the other here so we don't show approximately the same section twice (I'd lean towards preferring GitHub).

warehouse/templates/includes/packaging/project-data.html

di

LGTM aside from my question about the CSS

warehouse/static/sass/blocks/_vertical-tabs.scss

nlhkabu · 2018-07-29T10:24:16Z

As discussed in the sprints, we're going to create a new SCSS component for these links as vertical-tabs is probably not the best fit for this use case :)

nlhkabu · 2018-07-29T13:20:53Z

@am-on - what project were you testing this with in development?

am-on · 2018-07-29T13:50:00Z

@nlhkabu not sure which is gitlab and which github

pymagnitude
krangpower

paternal · 2018-08-02T08:17:22Z

This is nice. 😄

However, Gitlab being free, there are several instances (for instance, my projects are hosted at Framagit). While having warehouse check a list of every single public gitlab instance is a bad idea, I wonder if it would be possible to:

Check if the project homepage URL is a gitlab instance;
If so, fetch and display its statistics.

Thanks for your work!

Added star and fork statistics on detailed project view for projects with an valid GitLab URL. Ref: pypi#4301

GitLab has no view for stars, so it shouldn't be presented as clickable link. We are prefering GitHub over GitLab. Because of that we can generalize class names as only one of them gets rendered.

nlhkabu · 2018-11-18T14:01:22Z

Thanks again for this PR @am-on - and sorry for the delay on getting back to it!

I've just pushed a PR that separates out the CSS classes from the JS class (the JS hook is now js-repo-data).

I've also updated the template to be (what I think is) more readable, and adapted the SCSS accordingly.

@yeraydiazdiaz would you be able to re-review the JS for this PR? There is an empty catch function at the bottom of repository-info.js that I am not sure about :)

yeraydiazdiaz

Thanks for your PR @am-on, @nlhkabu the JS changes look ok on their own, but I feel it could be handled nicely in a Stimulus controller, we could tackle that in a separate PR.

I left a minor comment on the Python side, not a blocker but a nice to have if @am-on is up for it 👍

yeraydiazdiaz · 2018-11-18T14:08:51Z

warehouse/packaging/models.py

+                parsed.netloc == "gitlab.com" or parsed.netloc == "www.gitlab.com"
+            ) and len(segments) >= 2:
+                user_name, repo_name = segments[:2]
+                return f"https://gitlab.com/api/v4/projects/{user_name}%2F{repo_name}"


this property has a lot of common code with the above. It's not a blocker for the PR, but it'd be nice if we could refactor the common logic into a helper function.

brainwane · 2019-03-22T19:23:07Z

@am-on would you be interested in finishing this up?

Also, some of us will be at the PyCon North America sprints again this year, May 6th-9th, in case you would like to join us then!

brainwane · 2019-06-18T20:39:33Z

@am-on Is this ready to be re-reviewed?

nlhkabu · 2019-06-22T09:04:50Z

I believe this is waiting on another HTML and SCSS review on my side (and possible updates).

nlhkabu · 2019-09-15T11:00:14Z

Note:
If / when this PR is re-reviewed, we will need to ensure that the template is appropriately translated.

yeraydiazdiaz · 2020-01-26T10:15:16Z

@am-on would you be interested in continuing work on this? Looks like it was pretty close to merging.

miketheman · 2022-12-16T15:42:49Z

#Triage
Hey @am-on ! It's been a couple of years since, and we're curious if you're still interested in working on this?

Some recent changes to the code would need to be resolved, as the Javascript logic has moved as of #12666

miketheman · 2024-02-23T16:58:14Z

This is still. a good idea, but due to age, too many conflicts, closing this PR. If there's still interest, please revive.

am-on force-pushed the 4301-add-gitlab-stat branch from 0647ada to c893fdf Compare July 28, 2018 15:10

di requested changes Jul 28, 2018

View reviewed changes

am-on commented Jul 28, 2018

View reviewed changes

warehouse/templates/includes/packaging/project-data.html Outdated Show resolved Hide resolved

am-on commented Jul 28, 2018

View reviewed changes

warehouse/templates/includes/packaging/project-data.html Outdated Show resolved Hide resolved

am-on changed the title ~~Add GitLab Statistics~~ [WIP] Add GitLab Statistics Jul 28, 2018

am-on force-pushed the 4301-add-gitlab-stat branch 2 times, most recently from 6e3ebc0 to 178c0bc Compare July 28, 2018 20:25

am-on changed the title ~~[WIP] Add GitLab Statistics~~ Add GitLab Statistics Jul 28, 2018

di approved these changes Jul 29, 2018

View reviewed changes

warehouse/static/sass/blocks/_vertical-tabs.scss Outdated Show resolved Hide resolved

am-on and others added 6 commits November 18, 2018 09:38

Add GitLab Statistics

da16473

Added star and fork statistics on detailed project view for projects with an valid GitLab URL. Ref: pypi#4301

Remove pdb comment

e64150e

Fix links for GitLab statistics items, generalize statistics classes

37aa061

GitLab has no view for stars, so it shouldn't be presented as clickable link. We are prefering GitHub over GitLab. Because of that we can generalize class names as only one of them gets rendered.

Use macro for statistics items

c26c00a

Move styling for repo statistics to its own file

4e28fd5

Follow BEM for CSS, use separate class for JS hooks

5d9e21c

nlhkabu force-pushed the 4301-add-gitlab-stat branch from cc024e4 to 5d9e21c Compare November 18, 2018 13:57

nlhkabu requested a review from yeraydiazdiaz November 18, 2018 14:01

nlhkabu approved these changes Nov 18, 2018

View reviewed changes

yeraydiazdiaz approved these changes Nov 18, 2018

View reviewed changes

Fix linting issue

595ed0d

nlhkabu added the UX/UI design, user experience, user interface label May 20, 2019

nlhkabu self-assigned this Jun 22, 2019

Merge branch 'master' into 4301-add-gitlab-stat

121271b

Base automatically changed from master to main January 21, 2021 18:39

miketheman added the awaiting-response PRs and issues that are awaiting author response label Dec 16, 2022

jayaddison mentioned this pull request Jan 9, 2023

Project detail statistics: support multiple statistics providers #12789

Closed

am-on requested a review from a team as a code owner February 22, 2024 19:07

miketheman closed this Feb 23, 2024

Add GitLab Statistics #4384

Add GitLab Statistics #4384

Uh oh!

Conversation

am-on commented Jul 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

am-on commented Jul 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

di Jul 28, 2018

Choose a reason for hiding this comment

Uh oh!

nlhkabu commented Jul 28, 2018

Uh oh!

di commented Jul 28, 2018

Uh oh!

Uh oh!

Uh oh!

di left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nlhkabu commented Jul 29, 2018

Uh oh!

nlhkabu commented Jul 29, 2018

Uh oh!

am-on commented Jul 29, 2018

Uh oh!

paternal commented Aug 2, 2018

Uh oh!

nlhkabu commented Nov 18, 2018

Uh oh!

yeraydiazdiaz left a comment

Choose a reason for hiding this comment

Uh oh!

yeraydiazdiaz Nov 18, 2018

Choose a reason for hiding this comment

Uh oh!

brainwane commented Mar 22, 2019

Uh oh!

brainwane commented Jun 18, 2019

Uh oh!

nlhkabu commented Jun 22, 2019

Uh oh!

nlhkabu commented Sep 15, 2019

Uh oh!

yeraydiazdiaz commented Jan 26, 2020

Uh oh!

miketheman commented Dec 16, 2022

Uh oh!

miketheman commented Feb 23, 2024

Uh oh!

Uh oh!

am-on commented Jul 28, 2018 •

edited

Loading

am-on commented Jul 28, 2018 •

edited

Loading