Commit 5851e7d6 authored by Louis's avatar Louis
Browse files

[doc] Write README file

parent 4fcb2a98
Pipeline #7477 passed with stage
in 28 seconds
......@@ -3,17 +3,33 @@ PypiMonitor — Monitor your pypi packages
|sources| |pypi| |build| |documentation| |license|
TODO Link to documentation `documentation <https://pypimonitor.readthedocs.io>`__.
TODO Screenshot
An HTML dashboard to monitor your `PyPI packages <//pypi.python.org>`_. It
displays a line charts showing the evolution of downloads across versions, and
a set of badges (download statistics, `readthedocs <//readthedocs.io>`__ badge,
continuous integration, etc.). See the example below.
|example|
It is available as a `command line interface
<//pypimonitor.readthedocs.io/TODO>`_ that generates the HTML code, and as a
`web server <//pypimonitor.readthedocs.io/TODO>`_, to generate and serve this
dashboard.
What's new?
-----------
See `changelog
<https://git.framasoft.org/spalax/pypimonitor/blob/master/CHANGELOG.md>`_.
<//framagit.org/spalax/pypimonitor/blob/master/CHANGELOG.md>`_.
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 github pages, readthedocs, etc., and conquer the world;
- or replace this quick and dirty web server using `your favorite web framework <//wiki.python.org/moin/WebFrameworks>`_, 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
--------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment