pypstats 1.4

Description:

pypstats 1.4

SYNOPSIS
pypstats is for retrieving monthly and per release download statistics
of packages that are distributed via PyPI.
It can be used to write .csv files, plot monthly stats, and retrieve
information on the latest release. Monthly statistics are stored at
http://pypi.python.org/stats/months/ in compressed files starting from
June 2010. These files contain information on releases that are removed
from PyPI, so pypstats provides complete statistics for packages that
are released after June 2010.


INSTALLATION
Download a package file from http://pypi.python.org/pypi/pypstats. Extract
its contents and run setup.py as follows:
$ tar -xzf pypstats-1.x.tar.gz
$ cd pypstats-1.x
$ python setup.py install
Or, if if you have Easy Install
installed, type the following:
$ easy_install -U pypstats


USAGE

First use
Before statistics can be printed or plotted, you need to retrieve statistics
and save them locally using pypstats update command:
$ pypstats update ProDy
Fetching content from 'http://pypi.python.org/stats/months/'.
Parsing monthly statistics file details.
Updating statistics for 2010-06.
...
Updating statistics for 2012-01.
Package statistics are updated (ProDy_stats.pkl).
Retrieving statistics at the first use will take some time, since all
monthly stats files are downloaded. Note that downloaded files will be
save in temporary folder, unless --nocache option is passed. Saving
downloaded files will make building stats file for multiple packages faster.


Monthly stats
Monthly statistics can be printed using pypstats monthly command:
$ pypstats monthly ProDy_stats.pkl
Loading statistics from 'ProDy_stats.pkl'.
Month Downloads
2010-11 286
...
2012-01 1041
Total 10664
This information can also be plotted and saved in a .csv file as
follows:
$ pypstats monthly -o monthly.csv -p monthly.png ProDy_stats.pkl
Loading statistics from 'ProDy_stats.pkl'.
Monthly statistics are written in 'monthly.csv'.
Monthly downloads plot is saved as 'monthly.png'.


Release stats
Release statistics can be printed using pypstats release command:
$ pypstats release ProDy_stats.pkl
Loading statistics from 'ProDy_stats.pkl'.
Release Downloads
0.1.0 397
...
0.9.2 328
Total 10664
Similarly, output can be written into a .csv file as follows:
$ pypstats release -o release_stats.csv -q ProDy_stats.pkl
Note that -q argument suppresses messages written to stderr.


Total downloads
Total number of downloads can be printed using pypstats total command:
$ pypstats total -q ProDy_stats.pkl
10664


Latest release
Latest release information can be retrieved using pypstats latest
command:
$ pypstats latest -q ProDy
File URL md5 Type Py Version Size Downloads
ProDy-0.9.2.tar.gz http://pypi.python.org/packages/source/P/ProDy/ProDy-0.9.2.tar.gz 9ad6f6e6012f824ea5e7acb344607eae Source 711KB 119
ProDy-0.9.2.win32-py2.6.exe http://pypi.python.org/packages/2.6/P/ProDy/ProDy-0.9.2.win32-py2.6.exe 51f8587dcc8fe6d0355327d811ea71c3 MS Windows installer 2.6 455KB 47
ProDy-0.9.2.win32-py2.7.exe http://pypi.python.org/packages/2.7/P/ProDy/ProDy-0.9.2.win32-py2.7.exe 68ba279f3d9e02b38e4f3e6339b41b26 MS Windows installer 2.7 909KB 53
ProDy-0.9.2.zip http://pypi.python.org/packages/source/P/ProDy/ProDy-0.9.2.zip b447f8b607defd5cda65163e43b32150 Source 744KB 109
This information can be written into a CSV file using reStructured Text style:
$ pypstats latest -q -o latest_release.csv --rst ProDy
This file can be used in a page prepared using Sphinx,
see for an example: http://www.csb.pitt.edu/ProDy/getprody.html


Updates
Local statistics file can be updated using pypstats update command:
$ pypstats update -s ProDy_stats.pkl ProDy
Fetching content from 'http://pypi.python.org/stats/months/'.
Parsing monthly statistics file details.
Nothing to update.
This command will make an incremental update by downloading the files that
changed since the last update.


Help
To get help, type in a command name with -h argument:
$ pypstats -h
usage: pypstats.py [-h] {latest,monthly,total,update,release} ...

Fetch package download statistics from Python Package Index (PyPI). Package
needs to be distributed via PyPI.

optional arguments:
-h, --help show this help message and exit

subcommands:
{latest,monthly,total,update,release}
update retrieve or update download statistics
latest retrieve and output latest release information
monthly output/plot monthly download statistics
release output download statistics by release
total output total number of downloads

See 'pypstats <command> -h' for more information on a specific command.
$ pypstats monthly -h
usage: pypstats.py monthly [-h] [-q] [-o FILENAME] [-d DELIMITER]
[-p FILENAME] [--dpi INT] [--mlabelstep INT]
pkl

positional arguments:
pkl package statistics filename

optional arguments:
-h, --help show this help message and exit
-q, --quiet suppress stderr log messages
-o FILENAME output CSV filename, if not provided print to stdout
-d DELIMITER output column delimiter (default: ' ')
-p FILENAME figure filename, requires Matplotlib
--dpi INT figure resolution (default: '72')
--mlabelstep INT figure month label step (default: '2')


Functions
from pypstats import * imports the following functions which can be used
directly in Python code:

pyps_update(package, pkl, cache) - update package statistics
pyps_monthly(pkl) - return monthly download statistics
pyps_release(pkl) - return release download statistics
pyps_total(pkl) - return total number of downloads




LICENSE
pypstats is available under GNU General Public License version 3. See
LICENSE.rst for more details.


CHANGES

v1.3

Added new functions that can be used directly in Python code. See usage
section above.
Using timestamps when saving downloaded stats file so that time zone
differences do not cause a problem.



v1.2.1

Fixed an installation problem.



v1.2

Renamed script pypstats to pyps.
Downloaded stats files are save to temp folder. When multiple package stats
are updated consequently, content is read from this folder.



v1.1

Renamed command current to latest.




SOURCE
http://github.com/abakan/pypstats


REPORT ISSUES
https://github.com/abakan/pypstats/issues