Statistics

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
analytics, api

Research direction

Start by reviewing the REST API work in issue #9 and the existing XML-RPC interface, since the issue identifies these as possible integration paths. Done means exposing patch submission and reply counts through a stats API for day, week, month, and year periods; series statistics are explicitly deferred.

Written by the indexing model from the issue text.

Description

enhancement

From @stephenfin on June 29, 2015 21:15

Overview

Add support for a 'stats' API, which will give access to various projects statistics. We require at least the following:

  • Number of submitted patches over given time period (day, week, month, year)
  • Number of replies to patches over same periods

Ideally we should also be able to do this for series, but this relies on the work being undertaken by @dlespiau so it will need to wait.

Dependencies

This feature may depend on the integration of a REST API, else the XML-RPC interface can be used (though this has downsides).

Additional Work Items

We will need to add support for additional statistics as they become available (i.e. series). We may also wish to add some graphs to make these visualize these statistics for user.

Alternatives

There is no alternative to this in patchwork itself. If you have access to the database, you could theoretically write your own queries but they won't be public. The best alternative is through the use of Mailman. Mailman 3.0 comes with a REST API that we can parse much of the information from. However, in most mailing lists patches are mixed with other development questions so the statistics that Mailman would return will need some work. A distinct patchwork API would complement the Mailman API quite nicely.

Useful resources

Copied from original issue: stephenfin/patchwork#20

Dominant language
Python
Stars
317
Forks
91
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getpatchwork/patchwork

All issues in getpatchwork/patchwork

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.