{"id":13502519,"url":"https://github.com/ionelmc/django-redisboard","last_synced_at":"2025-04-12T22:36:09.208Z","repository":{"id":637894,"uuid":"2688418","full_name":"ionelmc/django-redisboard","owner":"ionelmc","description":"Redis monitoring and inspection tool in django admin.","archived":false,"fork":false,"pushed_at":"2022-11-16T14:45:25.000Z","size":1324,"stargazers_count":275,"open_issues_count":6,"forks_count":47,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-04T02:09:26.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/django-redisboard","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ionelmc.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-11-01T15:27:26.000Z","updated_at":"2025-03-11T03:16:42.000Z","dependencies_parsed_at":"2023-01-13T10:32:56.166Z","dependency_job_id":null,"html_url":"https://github.com/ionelmc/django-redisboard","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fdjango-redisboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fdjango-redisboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fdjango-redisboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fdjango-redisboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ionelmc","download_url":"https://codeload.github.com/ionelmc/django-redisboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642709,"owners_count":21138352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T22:02:16.637Z","updated_at":"2025-04-12T22:36:09.186Z","avatar_url":"https://github.com/ionelmc.png","language":"Python","funding_links":[],"categories":["Python","Performance Monitoring"],"sub_categories":[],"readme":"========\nOverview\n========\n\n.. start-badges\n\n.. list-table::\n    :stub-columns: 1\n\n    * - docs\n      - |docs|\n    * - tests\n      - | |github-actions| |requires|\n        | |coveralls| |codecov|\n    * - package\n      - | |version| |wheel| |supported-versions| |supported-implementations|\n        | |commits-since|\n\n.. |docs| image:: https://readthedocs.org/projects/django-redisboard/badge/?style=flat\n    :target: https://django-redisboard.readthedocs.io/\n    :alt: Documentation Status\n\n.. |github-actions| image:: https://github.com/ionelmc/django-redisboard/actions/workflows/github-actions.yml/badge.svg\n    :alt: GitHub Actions Build Status\n    :target: https://github.com/ionelmc/django-redisboard/actions\n\n.. |requires| image:: https://requires.io/github/ionelmc/django-redisboard/requirements.svg?branch=master\n    :alt: Requirements Status\n    :target: https://requires.io/github/ionelmc/django-redisboard/requirements/?branch=master\n\n.. |coveralls| image:: https://coveralls.io/repos/ionelmc/django-redisboard/badge.svg?branch=master\u0026service=github\n    :alt: Coverage Status\n    :target: https://coveralls.io/r/ionelmc/django-redisboard\n\n.. |codecov| image:: https://codecov.io/gh/ionelmc/django-redisboard/branch/master/graphs/badge.svg?branch=master\n    :alt: Coverage Status\n    :target: https://codecov.io/github/ionelmc/django-redisboard\n\n.. |version| image:: https://img.shields.io/pypi/v/django-redisboard.svg\n    :alt: PyPI Package latest release\n    :target: https://pypi.org/project/django-redisboard\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/django-redisboard.svg\n    :alt: PyPI Wheel\n    :target: https://pypi.org/project/django-redisboard\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/django-redisboard.svg\n    :alt: Supported versions\n    :target: https://pypi.org/project/django-redisboard\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/django-redisboard.svg\n    :alt: Supported implementations\n    :target: https://pypi.org/project/django-redisboard\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/ionelmc/django-redisboard/v8.4.0.svg\n    :alt: Commits since latest release\n    :target: https://github.com/ionelmc/django-redisboard/compare/v8.4.0...master\n\n\n\n.. end-badges\n\nRedis monitoring and inspection drop-in application using django admin.\n\n* Free software: BSD 2-Clause License\n\nFeatures\n========\n\n* Sever statistics in the admin changelist\n* Key summary in the inspect view\n* Value introspection with pagination for lists and sorted sets\n\nDon't have a django project?\n============================\n\nIf you just want to run redisboard quickly do this::\n\n    pip install django-redisboard\n    redisboard\n\nDon't want to run on 0.0.0.0:8000? Run::\n\n    redisboard ip:port\n\nWant a password that ain't random (you might need to ``rm -rf ~/.redisboard`` first tho)? Run::\n\n    redisboard --password=foobar\n\nInstallation guide\n==================\n\nInstall from pypi, with pip::\n\n    pip install django-redisboard\n\nAdd ``redisboard`` to ``INSTALLED_APPS``:\n\n::\n\n    INSTALLED_APPS += (\"redisboard\", )\n\nAfter that you need to run::\n\n    manage.py migrate\n\nThen you can add redis servers in the admin. You will see the stats in the changelist.\n\nRedisboard has few css tweaks for the pages (they are optional). If you use staticfiles just run::\n\n    manage.py collectstatic\n\nIf you do not use django.contrib.staticfiles you must manually symlink the\nsite-packages/redisboard/static/redisboard dir to \u003cyour media root\u003e/redisboard.\n\nOptional Django settings\n========================\n\n======================================= ====\nSetting name                            Description\n======================================= ====\n``REDISBOARD_CONNECTION_POOL_OPTIONS``  Extra connection options. Default: ``{}``. Example:\n\n                                        .. sourcecode:: python\n\n                                            REDISBOARD_CONNECTION_POOL_OPTIONS = {'socket_timeout': 60, 'socket_connect_timeout': 10}\n\n\n``REDISBOARD_DECODER_CLASS``            Default: ``'redisboard.data.UTF8BackslashReplaceDecoder'``.\n``REDISBOARD_DISPLAY_CLASS``            Default: ``'redisboard.data.TabularDisplay'``.\n``REDISBOARD_VALUE_QUERY_CLASS``        Default: ``'redisboard.data.ValueQuery'``.\n``REDISBOARD_LENGTH_QUERY_CLASS``       Default: ``'redisboard.data.LengthQuery'``.\n``REDISBOARD_DETAIL_FILTERS``           A list of regular expressions to match against the keys in the server\n                                        details colum. Eg, to only show uptime and list of active databases:\n\n                                        .. sourcecode:: python\n\n                                            REDISBOARD_DETAIL_FILTERS = ['uptime.*', 'db.*']\n\n                                        To show all the details just use:\n\n                                        .. sourcecode:: python\n\n                                            REDISBOARD_DETAIL_FILTERS = ['.*']\n``REDISBOARD_DETAIL_CONVERTERS``        Mapping of regexes to functions to convert those values. Checkout the sourcecode for what's\n                                        available.\n``REDISBOARD_SLOWLOG_NUM``              Number of slowlog entries to show. Default: ``10``.\n``REDISBOARD_SCAN_COUNT``               Count used for the various scan commands. Affects pagination for key list and key details.\n                                        Default: ``1000``.\n``REDISBOARD_STRING_PAGINATION``        Count used just for paginating string values. Default: ``10000``\n======================================= ====\n\nScreenshots\n===========\n\nScreenshot of the changelist:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/changelist.png\n    :alt: Screenshot of the changelist\n\nScreenshot of inspecting:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect.png\n    :alt: Screenshot of inspecting\n\nScreenshot of inspecting a sorted set:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-sorted-set.jpg\n    :alt: Screenshot of inspecting a sorted set\n\nScreenshot of inspecting a db:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-db.jpg\n    :alt: Screenshot of inspecting a db\n\nScreenshot of inspecting a big string:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-big-string.jpg\n    :alt: Screenshot of inspecting a big string\n\nScreenshot of inspecting a hash:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-hash.jpg\n    :alt: Screenshot of inspecting a hash\n\nScreenshot of inspecting a hash with binary values:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-hash.jpg\n    :alt: Screenshot of inspecting a hash with binary values\n\nScreenshot of inspecting a binary string:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-string.jpg\n    :alt: Screenshot of inspecting a binary string\n\nScreenshot of inspecting a binary key:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-key.jpg\n    :alt: Screenshot of inspecting a binary key\n\nScreenshot of inspecting a set:\n\n.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-set.jpg\n    :alt: Screenshot of inspecting a set\n\nDocumentation\n=============\n\nhttps://django-redisboard.readthedocs.org/en/latest/\n\nDevelopment\n===========\n\nTo run the all tests run::\n\n    tox\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionelmc%2Fdjango-redisboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fionelmc%2Fdjango-redisboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionelmc%2Fdjango-redisboard/lists"}