Metadata-Version: 1.1
Name: django-redisboard
Version: 2.0.0
Summary: Redis monitoring and inspection drop-in application using django admin.
Home-page: https://github.com/ionelmc/django-redisboard
Author: Ionel Cristian Mărieș
Author-email: contact@ionelmc.ro
License: BSD
Description: =================
        django-redisboard
        =================
        
        .. list-table::
            :stub-columns: 1
        
            * - docs
              - |docs|
            * - tests
              - | |travis| |appveyor| |requires|
                | |coveralls| |codecov|
                | |landscape| |scrutinizer| |codacy| |codeclimate|
            * - package
              - |version| |downloads| |wheel| |supported-versions| |supported-implementations|
        
        .. |docs| image:: https://readthedocs.org/projects/django-redisboard/badge/?style=flat
            :target: https://readthedocs.org/projects/django-redisboard
            :alt: Documentation Status
        
        .. |travis| image:: https://travis-ci.org/ionelmc/django-redisboard.svg?branch=master
            :alt: Travis-CI Build Status
            :target: https://travis-ci.org/ionelmc/django-redisboard
        
        .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/ionelmc/django-redisboard?branch=master&svg=true
            :alt: AppVeyor Build Status
            :target: https://ci.appveyor.com/project/ionelmc/django-redisboard
        
        .. |requires| image:: https://requires.io/github/ionelmc/django-redisboard/requirements.svg?branch=master
            :alt: Requirements Status
            :target: https://requires.io/github/ionelmc/django-redisboard/requirements/?branch=master
        
        .. |coveralls| image:: https://coveralls.io/repos/ionelmc/django-redisboard/badge.svg?branch=master&service=github
            :alt: Coverage Status
            :target: https://coveralls.io/r/ionelmc/django-redisboard
        
        .. |codecov| image:: https://codecov.io/github/ionelmc/django-redisboard/coverage.svg?branch=master
            :alt: Coverage Status
            :target: https://codecov.io/github/ionelmc/django-redisboard
        
        .. |landscape| image:: https://landscape.io/github/ionelmc/django-redisboard/master/landscape.svg?style=flat
            :target: https://landscape.io/github/ionelmc/django-redisboard/master
            :alt: Code Quality Status
        
        .. |codacy| image:: https://img.shields.io/codacy/REPLACE_WITH_PROJECT_ID.svg?style=flat
            :target: https://www.codacy.com/app/ionelmc/django-redisboard
            :alt: Codacy Code Quality Status
        
        .. |codeclimate| image:: https://codeclimate.com/github/ionelmc/django-redisboard/badges/gpa.svg
           :target: https://codeclimate.com/github/ionelmc/django-redisboard
           :alt: CodeClimate Quality Status
        .. |version| image:: https://img.shields.io/pypi/v/django-redisboard.svg?style=flat
            :alt: PyPI Package latest release
            :target: https://pypi.python.org/pypi/django-redisboard
        
        .. |downloads| image:: https://img.shields.io/pypi/dm/django-redisboard.svg?style=flat
            :alt: PyPI Package monthly downloads
            :target: https://pypi.python.org/pypi/django-redisboard
        
        .. |wheel| image:: https://img.shields.io/pypi/wheel/django-redisboard.svg?style=flat
            :alt: PyPI Wheel
            :target: https://pypi.python.org/pypi/django-redisboard
        
        .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/django-redisboard.svg?style=flat
            :alt: Supported versions
            :target: https://pypi.python.org/pypi/django-redisboard
        
        .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/django-redisboard.svg?style=flat
            :alt: Supported implementations
            :target: https://pypi.python.org/pypi/django-redisboard
        
        .. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/ionelmc/django-redisboard/master.svg?style=flat
            :alt: Scrutinizer Status
            :target: https://scrutinizer-ci.com/g/ionelmc/django-redisboard/
        
        Redis monitoring and inspection drop-in application using django admin.
        
        * Free software: BSD license
        
        Features
        ========
        
        * Sever statistics in the admin changelist
        * Key summary in the inspect view
        * Value introspection with pagination for lists and sorted sets
        
        Requirements
        ============
        
        :OS: Any
        :Runtime: Python 2.7, 3.4, 3.4 or PyPy
        :Services: Redis 2.2 or later.
        :Packages: Django>=1.3, py-redis>=2.10.0
        
        Don't have a django project ?
        =============================
        
        Use the quick start script ! It will create and run a django project on 0.0.0.0:8000 with just the redisboard installed.
        
        With curl::
        
            curl -L https://raw.github.com/ionelmc/django-redisboard/master/run_redisboard.py | tee run_redisboard.py | sh -e
        
        With wget::
        
            wget --no-check-certificate https://raw.github.com/ionelmc/django-redisboard/master/run_redisboard.py -O - | tee run_redisboard.py | sh -e
        
        Don't want to run on 0.0.0.0:8000 ? Run::
        
            ./run_redisboard.py ip:port
        
        Installation guide
        ==================
        
        Install from pypi, with pip::
        
            pip install django-redisboard
        
        Or with setuptools::
        
            easy_install django-redisboard
        
        Add ``redisboard`` to ``INSTALLED_APPS``:
        
        ::
        
            INSTALLED_APPS += ("redisboard", )
        
        After that you need to run::
        
            manage.py syncdb
        
        Or if you use south you can migrate this app::
        
            manage.py migrate redisboard
        
        Then you can add redis servers in the admin. You will see the stats in the changelist.
        
        Redisboard has few css tweaks for the pages (they are optional). If you use staticfiles just run::
        
            manage.py collectstatic
        
        If you do not use django.contrib.staticfiles you must manually symlink the
        site-packages/redisboard/static/redisboard dir to <your media root>/redisboard.
        
        Optional django settings
        ========================
        
        REDISBOARD_DETAIL_FILTERS
        -------------------------
        
        REDISBOARD_DETAIL_FILTERS - a list of regular expressions to match against the keys in the server
        details colum. Eg, to only show uptime and list of active databases::
        
            REDISBOARD_DETAIL_FILTERS = ['uptime.*', 'db.*']
        
        To show all the details just use::
        
            REDISBOARD_DETAIL_FILTERS = ['.*']
        
        REDISBOARD_ITEMS_PER_PAGE
        -------------------------
        
        REDISBOARD_ITEMS_PER_PAGE - default 100. Used for paginating the items from a list or a sorted set.
        
        REDISBOARD_SOCKET_TIMEOUT
        -------------------------
        
        REDISBOARD_SOCKET_TIMEOUT - default None. Socket operations time out after this many seconds.
        
        REDISBOARD_SOCKET_CONNECT_TIMEOUT
        ---------------------------------
        
        REDISBOARD_SOCKET_CONNECT_TIMEOUT - default None. Socket connect operation times out after this many seconds.
        
        REDISBOARD_SOCKET_KEEPALIVE
        ---------------------------
        
        REDISBOARD_SOCKET_KEEPALIVE - default None. Enables or Disables socket keepalive.
        
        REDISBOARD_SOCKET_KEEPALIVE_OPTIONS
        -----------------------------------
        
        REDISBOARD_SOCKET_KEEPALIVE_OPTIONS - default None. Additional options for socket keepalive.
        
        
        Screenshots
        ===========
        
        Changelist:
        
        .. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/changelist.png
        
        Inspect:
        
        .. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect.png
        
        Inspect key details:
        
        .. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-key.png
        
        
        Documentation
        =============
        
        https://django-redisboard.readthedocs.org/en/latest/
        
        Development
        ===========
        
        To run the all tests run::
        
            tox
        
        
        Changelog
        ============
        
        2.0.0 (2015-11-08)
        ------------------
        
        * Fix error handling in couple places. Now pages don't return 500 errors if there's something bad going on with the
          redis connection.
        * Remove key stats that came from ``DEBUG OBJECT`` (LRU, Address, Length etc). Now ``OBJECT
          [REFCOUNT|ENCODING|IDLETIME]`` is used instead. *BACKWARDS INCOMPATIBLE*
        
        1.2.2 (2015-10-11)
        ------------------
        
        * Exception handling for AWS ElastiCache Redis or any Redis that does not have DEBUG OBJECT command.
        * Enabled Redis keys to be inspected despite not having details from DEBUG OBJECT command.
        
        1.2.1 (2015-06-30)
        ------------------
        
        * Fixed a bug on Python 3 (no ``xrange``).
        * Fixed some issues the ``run_redisboard.py`` bootstrapper had with virtualenv.
        
        1.2.0 (2015-02-21)
        ------------------
        
        * Add ``REDISBOARD_SOCKET_TIMEOUT``, ``REDISBOARD_SOCKET_CONNECT_TIMEOUT``, ``REDISBOARD_SOCKET_KEEPALIVE`` and
          ``REDISBOARD_SOCKET_KEEPALIVE_OPTIONS`` options.
        
        1.1.0 (2015-01-21)
        ------------------
        
        * Fix broken slowlog display.
        
        1.0.0 (2014-12-10)
        ------------------
        
        * Show slowlog and cpu usage and more memory stats (contributed by Rick van Hattem)
        * Use pipelines to send commands for faster response (contributed by Rick van Hattem)
        * Added Python 3.3 and 3.4 support.
        * Added a test suite and other minor fixes.
        
        0.2.7 (?)
        ---------
        
        * N/A.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Classifier: Framework :: Django
Classifier: Topic :: Internet :: WWW/HTTP
