Commit d2053dc4 authored by Louis's avatar Louis
Browse files

README template

parent 8f7816b0
PypiMonitor — Monitor your pypi packages
========================================
|sources| |pypi| |documentation| |license|
TODO Link to documentation `documentation <https://pypimonitor.readthedocs.org/en/latest>`__.
TODO Screenshot
What's new?
-----------
See `changelog
<https://git.framasoft.org/spalax/pypimonitor/blob/master/CHANGELOG.md>`_.
Download and install
--------------------
* From sources:
* Download: https://pypi.python.org/pypi/pypimonitor
* Install (in a `virtualenv`, if you do not want to mess with your distribution installation system)::
python3 setup.py install
* From pip::
pip install pypimonitor
* Quick and dirty Debian (and Ubuntu?) package
This requires `stdeb <https://github.com/astraw/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
<http://pypimonitor.readthedocs.org>`_
* To compile it from source, download and run::
cd doc && make html
.. |documentation| image:: http://readthedocs.org/projects/pypimonitor/badge
:target: http://pypimonitor.readthedocs.org
.. |pypi| image:: https://img.shields.io/pypi/v/pypimonitor.svg
:target: http://pypi.python.org/pypi/pypimonitor
.. |license| image:: https://img.shields.io/pypi/l/pypimonitor.svg
:target: http://www.gnu.org/licenses/agpl-3.0.html
.. |sources| image:: https://img.shields.io/badge/sources-pypimonitor-brightgreen.svg
:target: http://git.framasoft.org/spalax/pypimonitor
# To perform those tests, install `tox` and run "tox" from this directory.
[tox]
# Uncomment to use more python versions
#envlist = py26, py27, py32, py34, py35, lint, doc
envlist = py34, py35, lint, doc
[testenv]
commands = {envpython} setup.py test
deps =
[testenv:lint]
basepython=python3.4
deps=pylint
commands=pylint squelette test --rcfile=pylintrc
[testenv:doc]
basepython=python3.4
changedir=doc
deps=-rdoc/requirements.txt
commands=sphinx-build -b html . _build/html
[testenv:coverage]
deps=coverage
basepython=3.4
commands=
coverage run --source pypimonitor -m unittest
coverage report
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