I'm working on the solution to this issue, and wanted to describe what I'm
planning for discussion and to ask a couple questions. (FYI @di)

Contributor credits

This doesn't fully address the initial request to have a 'developer profile' on
the warehouse page. But I thought the easiest way to do this was to simply query
Github and list the names of the people with links to their Github profile.

I initially tried to do this with a live query to Github at page load time,
but it took over 20 seconds thus making the page load way too long. So I
mentioned my plan to use a celery task on #pypa-dev and dstufft agreed it would
be the right way to go.
The major parts of this solution will be:
a. new table in the database (warehouse_contributors) (work complete)

b. celery task to query the Github api (this will require a Github API access
token owned by the PyPA and set via an environment variable) (work mostly
complete, still need to make it to run)

c. credits.html template which will display the people who have contributed
(planning to sort alphabetically by name, but could sort by commit count, open
for discussion) (work mostly complete)

d. Updated views.py. (work partially complete)

OSS libraries/dependencies used

I think this could be addressed by listing the requirements.txt dependencies
and linking to their PyPi project pages. We could start with a simple list
collected from requirements.txt, but then how would they be updated when
requirements are added or removed? Should we do a database table with this list
and a celery task to update these on a regular basis too? I don't think this
will enable displaying project icons such as Pyramid or SQLAlchemy, but that
could be a version 2.0 issue if enough people think its important.

My biggest question so far is about where to put this code. I'm currently
putting the celery task, view and model in warehouse/utils but only because it
didn't logically fit somewhere else in my mind. That was why I got a circular
import problem which I asked about on #pypa-dev, I had put the task in
warehouse/utils/init.py (repeating a pattern I saw in warehouse/packaging)
so I now have placed the task in warehouse/utils/tasks.py. Below is my layout:

Updates to existing files to support this work:
warehouse/config.py
warehouse/routes.py
warehouse/templates/base.html

New files:
warehouse/migrations/versions/497a94c766fd_add_contributor_table_for_issue_890.py - DB migration
warehouse/templates/pages/credits.html - new template
warehouse/utils/contributors.py - DB model
warehouse/utils/tasks.py - Celery task
warehouse/utils/views.py - new credits view

Is this agreeable or should I create a new directory, or put these in another
location entirely?

Thanks in advance.
-Matt

Create a credits page #890

Description

nlhkabuopenedon Jan 4, 2016

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

nlhkabu
openedon Jan 4, 2016