django-eraserhead 0.1.5

=============================
Django Eraserhead
=============================

.. image:: https://badge.fury.io/py/django-eraserhead.svg
:target: https://badge.fury.io/py/django-eraserhead

.. image:: https://travis-ci.org/dizballanze/django-eraserhead.svg?branch=master
:target: https://travis-ci.org/dizballanze/django-eraserhead

.. image:: https://codecov.io/gh/dizballanze/django-eraserhead/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dizballanze/django-eraserhead

通过延迟未使用字段提供优化数据库使用的提示

.. image:: https://github.com/dizballanze/django-eraserhead/raw/master/eraserhead.jpg

*警告* 仅在开发环境中使用此包！

文档
-------------

要求
-----------

* Django 1.9+
* Python 2.7, 3.4+

快速入门
----------

安装Django Eraserhead：

pip install django-eraserhead

将其添加到您的 `INSTALLED_APPS`

.. code-block:: python

INSTALLED_APPS = (
...
'eraserhead.apps.EraserheadConfig',
...
)

ERASERHEAD_ENABLED = True
ERASERHEAD_TRACEBACK_BASE_PATH = BASE_DIR


设置

* `ERASERHEAD_ENABLED` - 启用/禁用Django Eraserhead
* `ERASERHEAD_TRACEBACK_BASE_PATH` - 设置基础路径以筛选跟踪信息。设置为 `None` 以显示完整的跟踪信息。

功能
--------

.. image:: https://github.com/dizballanze/django-eraserhead/raw/master/screenshot.png

Django Eraserhead监视

* 考虑到延迟字段，查询集/模型的字段使用情况（已使用和未使用的字段）
* 每个查询集创建的实例数
* 每个查询集对应的模型
* 为每个查询集提供回溯，以便轻松找到相应的代码
* 计算未使用字段的内存消耗

基于字段的使用情况，Django Eraserhead为每个查询集建议优化。


待办事项
-----

* 用于部分统计收集的装饰器或上下文处理器
* 检测延迟字段加载
* 根据使用情况自动延迟字段
* 显示延迟字段

运行测试
-------------

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

鸣谢
-------

渲染此包使用的工具

* Cookiecutter_
* `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage