Commit a9da4dff authored by Louis's avatar Louis
Browse files

Merge branch 'master' into lycee

parents e4d38ea7 9ad4b8f1
......@@ -3,24 +3,24 @@ PypiMonitor — Monitor your pypi packages
|sources| |pypi| |build| |documentation| |license|
An HTML dashboard to monitor your `PyPI packages <//pypi.python.org>`_. It
An HTML dashboard to monitor your `PyPI packages <http://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,
a set of badges (download statistics, `readthedocs <http://readthedocs.io>`__ badge,
continuous integration, etc.). See the example below.
|example|
It is available as a `command line interface
<//pypimonitor.readthedocs.io/en/latest/module.html#pypimonitor-httpd>`_ that
<http://pypimonitor.readthedocs.io/en/latest/module#pypimonitor-httpd>`_ that
generates the HTML code, and as a `web server
<//pypimonitor.readthedocs.io/en/latest/module.html#pypimonitor-httpd>`_, to
<http://pypimonitor.readthedocs.io/en/latest/module#pypimonitor-httpd>`_, to
generate and serve this dashboard.
What's new?
-----------
See `changelog
<//framagit.org/spalax/pypimonitor/blob/master/CHANGELOG.md>`_.
<http://framagit.org/spalax/pypimonitor/blob/master/CHANGELOG.md>`_.
What's next?
------------
......@@ -28,7 +28,7 @@ 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.
- or replace this quick and dirty web server using `your favorite web framework <http://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… :)
......
......@@ -6,174 +6,123 @@ TODO
List of plugins
---------------
.. class:: base.Color
Base plugins
^^^^^^^^^^^^
``color``
"""""""""
TODO description
Produce a square of the same color of the corresponding download chart line. Takes no arguments.
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Empty
``TODO base.Empty``
"""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Error
``TODO base.Error``
"""""""""""""""""""
TODO description
``empty``
"""""""""
* Foo (required)
TODO Description
Produce an empty cell. Takes no arguments.
* Bar (default `baz`)
TODO Description
``error``
"""""""""
.. class:: base.Html
Produce a text corresponding to an error (this is used internally). Takes no arguments.
``TODO base.Html``
""""""""""""""""""
``html``
""""""""
TODO description
Copy raw html code.
* Foo (required)
TODO Description
* ``html`` (required)
The raw html code to render.
* Bar (default `baz`)
TODO Description
``link``
""""""""
.. class:: base.Link
Produce a link to an URL.
``TODO base.Link``
""""""""""""""""""
* ``href`` (required)
URL of the ressource to link to.
TODO description
* ``content`` (defaults to the `href` argument)
The text of the link.
* Foo (required)
TODO Description
Gitlab
^^^^^^
* Bar (default `baz`)
TODO Description
``gitlabci``
""""""""""""
.. class:: gitlab.CI
Produce a badge for latest `gitlabCI <//about.gitlab.com/gitlab-ci/>`_ build.
``TODO gitlab.CI``
""""""""""""""""""
* ``server`` (default `http://gitlab.com`)
URL of the gitlab server.
TODO description
* ``user`` (required)
Name of the user owning the package.
* Foo (required)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
* Bar (default `baz`)
TODO Description
Those options, combined, should produce the package URL: ``{server}/{user}/{slug}``.
.. class:: pypi.Homepage
PyPI
^^^^
``TODO pypi.Homepage``
``homepage``
""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
Package home page, retrieved from Pypi metadata.
.. class:: readthedocs.Readthedocs
`Readthedocs <http://readthedocs.io>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``TODO readthedocs.Readthedocs``
""""""""""""""""""""""""""""""""
``readthedocs``
"""""""""""""""
TODO description
`Readthedocs <http://readthedocs.io>` build badge.
* Foo (required)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
* Bar (default `baz`)
TODO Description
* ``branch``
Branch name, if the default branch should not be used.
.. class:: shields.PypiDailyDownloads
* ``lang``
Documentation language, if the default lang should not be used.
``TODO shields.PypiDailyDownloads``
"""""""""""""""""""""""""""""""""""
`Shields <http://shields.io>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiMonthlyDownloads
``TODO shields.PypiMonthlyDownloads``
"""""""""""""""""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiVersion
``TODO shields.PypiVersion``
""""""""""""""""""""""""""""
TODO description
``pypiddownloads``
""""""""""""""""""
* Foo (required)
TODO Description
Badge displaying Pypi daily download statistics.
* Bar (default `baz`)
TODO Description
``pypiwdownloads``
""""""""""""""""""
.. class:: shields.PypiWeeklyDownloads
Badge displaying Pypi weekly download statistics.
``TODO shields.PypiWeeklyDownloads``
""""""""""""""""""""""""""""""""""""
``pypimdownloads``
""""""""""""""""""
TODO description
Badge displaying Pypi monthly download statistics.
* Foo (required)
TODO Description
``pypiversion``
"""""""""""""""
* Bar (default `baz`)
TODO Description
Badge displaying Pypi version.
.. class:: travis.TravisCI
`Travis <http://travis-ci.org/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``TODO travis.TravisCI``
""""""""""""""""""""""""
``travisci``
""""""""""""
TODO description
`Travis <http://travis-ci.org/>`_ badge.
* Foo (required)
TODO Description
* ``user`` (required)
Travis username.
* Bar (default `baz`)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
Write your own
......@@ -182,12 +131,16 @@ Write your own
TODO
Raw
"""
^^^
TODO
Jinja2
""""""
^^^^^^
TODO
Default and Required arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
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