Metadata-Version: 2.0
Name: django-sysinfo
Version: 1.2
Summary: Simple django app to expose system infos: libraries version, databae server infos...
Home-page: https://github.com/saxix/django-sysinfo
Author: Stefano Apostolico
Author-email: s.apostolico@gmail.com
License: BSD
Keywords: django-sysinfo
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: psutil
Requires-Dist: pytz
Requires-Dist: six
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: mock (>=1.0.1); extra == 'dev'
Requires-Dist: pytest (>=3.0.7); extra == 'dev'
Requires-Dist: pytest-cache; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-django; extra == 'dev'
Requires-Dist: pytest-echo; extra == 'dev'
Requires-Dist: pytest-pythonpath; extra == 'dev'
Requires-Dist: setuptools (>=15.0); extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Requires-Dist: virtualenv (==12.0.2); extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: django; extra == 'dev'
Requires-Dist: ipython (<6.0); extra == 'dev'
Requires-Dist: pdbpp; extra == 'dev'
Requires-Dist: pip; extra == 'dev'
Requires-Dist: psycopg2; extra == 'dev'
Requires-Dist: check-manifest; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Provides-Extra: tests
Requires-Dist: coverage; extra == 'tests'
Requires-Dist: flake8; extra == 'tests'
Requires-Dist: mock (>=1.0.1); extra == 'tests'
Requires-Dist: pytest (>=3.0.7); extra == 'tests'
Requires-Dist: pytest-cache; extra == 'tests'
Requires-Dist: pytest-cov; extra == 'tests'
Requires-Dist: pytest-django; extra == 'tests'
Requires-Dist: pytest-echo; extra == 'tests'
Requires-Dist: pytest-pythonpath; extra == 'tests'
Requires-Dist: setuptools (>=15.0); extra == 'tests'
Requires-Dist: tox; extra == 'tests'
Requires-Dist: virtualenv (==12.0.2); extra == 'tests'
Requires-Dist: isort; extra == 'tests'

==============
django-sysinfo
==============

.. image:: https://badge.fury.io/py/django-sysinfo.png
    :target: https://badge.fury.io/py/django-sysinfo

.. image:: https://travis-ci.org/saxix/django-sysinfo.png?branch=master
    :target: https://travis-ci.org/saxix/django-sysinfo

Simple django app to expose system infos like libraries version, database server.

Easy to extend to add custom checks.

Features
--------

    - dump system informations
    - check API to add custom checks
    - simple echo
    - retrieve library version


Quickstart
----------

Install django-sysinfo::

    pip install django-sysinfo

put it in your `INSTALLED_APPS`::

    INSTALLED_APPS=[...
     'django_sysinfo'
    ]

add relevant entries in your url.conf::

    urlpatterns = (
        ....
        url(r'', include(django_sysinfo.urls)),
    )

or customize them::

    from django_sysinfo.views import http_basic_login, sysinfo

    urlpatterns = (
        url('sys/info/$', http_basic_login(sysinfo), name='sys-info'),
        url('sys/version/(?P<name>.*)/$', version, name='sys-version')
    )


Known issues and limitations
----------------------------

There are some limitations in the metrics returned by sysinfo, anyway this package is
not intended to be used as host/resources monitoring tool.

    - Disk space returns device info, any soft limits are ignored
    - Memory can be wrong in some virtual environments


Links
~~~~~

+--------------------+----------------+--------------+------------------------+
| Stable             | |master-build| | |master-cov| |                        |
+--------------------+----------------+--------------+------------------------+
| Development        | |dev-build|    | |dev-cov|    |                        |
+--------------------+----------------+--------------+------------------------+
| Project home page: |https://github.com/saxix/django-sysinfo                 |
+--------------------+---------------+----------------------------------------+
| Issue tracker:     |https://github.com/saxix/django-sysinfo/issues?sort     |
+--------------------+---------------+----------------------------------------+
| Download:          |http://pypi.python.org/pypi/django-sysinfo/             |
+--------------------+---------------+----------------------------------------+
| Documentation:     |https://django-sysinfo.readthedocs.org/en/latest/       |
+--------------------+---------------+--------------+-------------------------+

.. |master-build| image:: https://secure.travis-ci.org/saxix/django-sysinfo.png?branch=master
                    :target: http://travis-ci.org/saxix/django-sysinfo/

.. |master-cov| image:: https://codecov.io/github/saxix/django-sysinfo/coverage.svg?branch=master
            :target: https://codecov.io/github/saxix/django-sysinfo?branch=master


.. |dev-build| image:: https://secure.travis-ci.org/saxix/django-sysinfo.png?branch=develop
                  :target: http://travis-ci.org/saxix/django-sysinfo/

.. |dev-cov| image:: https://codecov.io/github/saxix/django-sysinfo/coverage.svg?branch=develop
        :target: https://codecov.io/github/saxix/django-sysinfo?branch=develop





=======
History
=======

1.2 16 Aug 2017
---------------
* fixex python 3.6 compatibility
* new config '_ttl' to set cache max_age attribute

1.1 14 Jul 2017
---------------
* Django 1.11 compatibility
* handle broken database connections
* add new mail server informations
* new 'checks' API
* BACKWARD INCONPATIBLE: new config format

1.0 (15 Mar 2017)
-----------------
* fixes error in json serialization
* BACKWARD INCOMPATIBLE: by default all the sections are disabled
* allow both string and callable in extra section
* added new configuration parameters
* new management command

0.3 (27 Mar 2016)
-----------------
* dropped support Django<1.6
* add `settings.SYSINFO_USERS` to manage access
* default Basic Authentication protected urls
* removed 'sys' prefix from default urlpatterns
* new 'echo' endpoint

0.2 (13 Feb 2016)
-----------------
* add some infos
* output sorted to improve readibility
* add ability to filter sections (?s=os,python)
* add CACHES infos
* removed command line utility


0.1.1 (20 Jan 2016)
-------------------
* improved coverage
* fixes typos in copyright


0.1.0 (15 Jan 2015)
-------------------
* First release on PyPI.


