django-memcache-status 项目技术文档

1. 安装指南

首先，将 memcache_status 添加到你的 INSTALLED_APPS 列表中。

INSTALLED_APPS = [
    # ...
    'memcache_status',
]

然后，你有两种方式来集成此应用：

1. 最快捷的方式是替换你的 Django Admin 首页为 django-memcache-status 提供的页面。这将显示 memcache 统计信息在左上角。这是 django-memcache-status 在 2.0 版本之前的行为。

在项目的任何 admin.py 文件中添加以下代码：

from django.contrib import admin
admin.site.index_template = 'memcache_status/admin_index.html'

2. 如果你需要手动放置统计信息，只需添加 CSS 文件并在你喜欢的任何位置包含 memcache-status 模板：

<link rel="stylesheet" href="{% static "memcache_status.css" %}"/>
{% include "memcache_status/memcache_status.html" %}

2. 项目使用说明

此应用将在你的 Django 管理界面中显示当前 memcached 实例的负载和一些统计信息。

支持的 memcached 绑定如下：

后端	支持
django.core.cache.backends.memcached.PyLibMCCache	√ 支持
django.core.cache.backends.memcached.PyMemcacheCache	× 不支持统计

其他绑定可能也提供了统计功能。

3. 项目API使用文档

本项目没有直接提供的API接口。它是设计来在你的 Django 管理界面中直接使用和显示信息的。

4. 项目安装方式

本地开发

使用 Pipenv 安装并运行测试：

$ pipenv install --dev
$ pipenv run test

你可以使用 tox 测试不同版本的 Python 和 Django：

$ tox

运行后，你将在 /tmp/coverage_report/django-memcache-status 目录下看到一个覆盖率报告。

你可以使用以下命令运行一个本地服务器以查看管理界面：

$ pipenv run django-admin.py migrate
$ pipenv run django-admin.py createsuperuser
$ pipenv run django-admin.py runserver

如果要测试特定的缓存后端，可以通过环境变量定义：

$ TEST_CACHE_BACKEND=django-pylibmc pipenv run django-admin.py runserver

请注意，如果你在 OS X 上测试 pylibmc 并且遇到错误，例如 'libmemcached/memcached.h' 文件未找到，你需要手动安装 pylibmc，然后重新运行安装：

$ brew install libmemcached
$ pipenv run pip install pylibmc --install-option="--with-libmemcached=/usr/local/Cellar/libmemcached/1.0.18_2/"
$ pipenv install --dev