pypimonitor

pypimonitor

An HTML dashboard to monitor pypi package.

passed c53e31f9 pylint · by Louis
Name Last Update
doc Loading commit data...
examples Loading commit data...
pypimonitor Loading commit data...
.gitlab-ci.yml Loading commit data...
AUTHORS Loading commit data...
CHANGELOG.md Loading commit data...
LICENSE Loading commit data...
README.rst Loading commit data...
pylintrc Loading commit data...
requirements.txt Loading commit data...
setup.cfg Loading commit data...
setup.py Loading commit data...
stdeb.cfg Loading commit data...
tox.ini Loading commit data...

PypiMonitor — Monitor your pypi packages

sources pypi build documentation license

Unfortunately, due to a pypi bug, download statistics got from the json API are bogus. So some of the data displayed by this program (download badges, and line charts) are bogus too… This will be fixed when the pypi bug itself will be fixed. See for instance #699 and #787.

An HTML dashboard to monitor your PyPI packages. It displays a line charts showing the evolution of downloads across versions, and a set of badges (download statistics, readthedocs badge, continuous integration, etc.). See the example below.

example

It is available as a command line interface that generates the HTML code, and as a web server, to generate and serve this dashboard.

What's new?

See changelog.

What's next?

This package replaces a static page that I manually updated from times to times. It does what I need, so there is little chance that I will develop it further. However, I see two directions this project could take:

  • break everything, remove every single line of python code, and rewrite everything in javascript, so that this can be served as a static page (from the server point of view) that can be published using gitlab pages or github pages, readthedocs, etc., and conquer the world;
  • or replace this quick and dirty web server using your favorite web framework, cache requests to the pypi API, publish it somewhere, and conquer the world.

I will do neither. But if you want to, you have my blessing… :)

Download and install

  • From sources:

  • From pip:

    pip install pypimonitor
    
  • Quick and dirty Debian (and Ubuntu?) package

    This requires stdeb to be installed:

    python3 setup.py --command-packages=stdeb.command bdist_deb
    sudo dpkg -i deb_dist/pypimonitor-<VERSION>_all.deb
    

Documentation

  • The compiled documentation is available on readthedocs

  • To compile it from source, download and run:

    cd doc && make html