Skip to content

Commit 9479f35

Browse files
3coinshugovkpre-commit-ci[bot]
authored
Updated docs for recent command. (#471)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 33d96ef commit 9479f35

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ usage: pypistats recent [-h] [-p {day,week,month}]
7373
[-v]
7474
package
7575

76-
Retrieve the aggregate download quantities for the last day/week/month
76+
Retrieve the aggregate download quantities for the last 1/7/30 days,
77+
excluding downloads from mirrors
7778

7879
positional arguments:
7980
package

src/pypistats/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,8 @@ def _paramify(param_name: str, param_value: float | str | None) -> str:
484484

485485

486486
def recent(package: str, period: str | None = None, **kwargs: str):
487-
"""Retrieve the aggregate download quantities for the last day/week/month"""
487+
"""Retrieve the aggregate download quantities for the last 1/7/30 days,
488+
excluding downloads from mirrors"""
488489
endpoint = f"packages/{package}/recent"
489490
params = _paramify("period", period)
490491
return pypi_stats_api(endpoint, params, **kwargs)

0 commit comments

Comments
 (0)