Skip to content

DOC: update the gh_stats code #12147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 1 commit into from
Sep 18, 2018
+5 −5
Merged

DOC: update the gh_stats code #12147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ GitHub Stats

We automatically extract GitHub issue, PRs, and authors from GitHub via the API::

python tools/github_stats.py --since-tag $TAG --project 'matplotlib/matplotlib' --links > doc/users/github_stats.rst
python tools/github_stats.py --since-tag v2.2.0 --milestone=v3.0 --project 'matplotlib/matplotlib' --links > doc/users/github_stats.rst

Review and commit changes. Some issue/PR titles may not be valid rst (the most common issue is
``*`` which is interpreted as unclosed markup).
Expand Down
8 changes: 4 additions & 4 deletions tools/github_stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def issues2dict(issues):
idict[i['number']] = i
return idict

def split_pulls(all_issues, project="ipython/ipython"):
def split_pulls(all_issues, project="matplotlib/matplotlib"):
"""split a list of closed issues into non-PR Issues and Pull Requests"""
pulls = []
issues = []
Expand All @@ -60,7 +60,7 @@ def split_pulls(all_issues, project="ipython/ipython"):
return issues, pulls


def issues_closed_since(period=timedelta(days=365), project="ipython/ipython", pulls=False):
def issues_closed_since(period=timedelta(days=365), project="matplotlib/matplotlib", pulls=False):
"""Get all issues closed since a particular point in time. period
can either be a datetime object, or a timedelta object. In the
latter case, it is used as a time before the present.
Expand Down Expand Up @@ -120,7 +120,7 @@ def report(issues, show_urls=False):
parser.add_argument('--days', type=int,
help="The number of days of data to summarize (use this or --since-tag)."
)
parser.add_argument('--project', type=str, default="ipython/ipython",
parser.add_argument('--project', type=str, default="matplotlib/matplotlib",
help="The project to summarize."
)
parser.add_argument('--links', action='store_true', default=False,
Expand Down Expand Up @@ -161,7 +161,7 @@ def report(issues, show_urls=False):
state='closed',
auth=True,
)
issues, pulls = split_pulls(issues_and_pulls)
issues, pulls = split_pulls(issues_and_pulls, project=project)
else:
issues = issues_closed_since(since, project=project, pulls=False)
pulls = issues_closed_since(since, project=project, pulls=True)
Expand Down