dealer 2.1.0

主页： http://github.com/klen/dealer
作者： Kirill Klenov <horneds@gmail.com>
作者邮箱： horneds@gmail.com
许可证： BSD
描述： |logo| Dealer
#############

.. _description

Dealer — 项目的SCM_版本辅助工具。只需将SCM_版本添加到
您的静态路径，即可在客户端浏览器缓存中实现自动控制

在模板中的某个位置： :

<script src='/main.js?{{ request.revision }}'

在客户端： :

<script src='/main.js?34jhfd45hd8'

支持Git_, Mercurial_和通过文件简单解析版本。

.. note:: 您应该安装Mercurial_以支持hg。

.. note:: 对于Django<2，请使用Dealer<3


.. _badges

.. image:: http://img.shields.io/travis/klen/dealer.svg?style=flat-square
:target: http://travis-ci.org/klen/dealer
:alt: 构建状态

.. image:: http://img.shields.io/coveralls/klen/dealer.svg?style=flat-square
:target: https://coveralls.io/r/klen/dealer
:alt: Coveralls

.. image:: http://img.shields.io/pypi/v/dealer.svg?style=flat-square
:target: https://pypi.python.org/pypi/dealer
:alt: 版本

.. image:: http://img.shields.io/pypi/dm/dealer.svg?style=flat-square
:target: https://pypi.python.org/pypi/dealer
:alt: 下载

.. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square
:target: https://www.gratipay.com/klen/
:alt: 捐赠


.. _contents

.. contents:


.. _requirements

需求
=============

- python 2.7, 3.5+

.. note:: 对于Django<2，请使用Dealer<3


.. _installation

安装
=============

**Dealer** 应使用pip安装： :

pip安装dealer


.. _usage

用法
=====

基本用法
-----------
::

from dealer.git import git

print git.revision

print git.tag

::

# 自动解析仓库类型
from dealer.auto import auto
print auto.revision

print auto.tag


手动创建后端
----------------------

**path** — SCM_仓库的路径（默认为当前目录）
::

from dealer.mercurial import Backend

hg = Backend('/path/to/hg/repo')


Django支持
--------------

设置
^^^^^^^^

**DEALER_TYPE** — SCM_仓库的类型 ('auto', 'git', 'mercurial', 'simple', 'env', 'null')。默认为 'auto';

**DEALER_PATH** — SCM_的路径。默认为当前目录；

**DEALER_SILENT** — 禁用日志警告；

**DEALER_BACKENDS** — 默认自动搜索的后端 ('git', 'mercurial', 'simple', 'env', 'null');


上下文处理器
^^^^^^^^^^^^^^^^^

将其附加到您的上下文处理器： :

...
上下文处理器 = ['dealer.contrib.django.context_processor']

并在您的模板中使用 *REVISION* 和 *TAG* 变量：

<link href="/test.css?{{ REVISION }}" rel="stylesheet" type="text/css" media="screen" />
<script src="/test.js?{{ REVISION }}"></script>

中间件
^^^^^^^^^^

将以下内容添加到您的设置中：

MIDDLEWARE = ['dealer.contrib.django.Middleware']

并在您的视图中使用：

def view(request)
return request.revision

或在您的模板中使用 `request.revision` 变量。


Flask 支持
-------------

设置
^^^^^^^^

*DEALER_TYPE* — SCM 仓库的类型 ('auto', 'git', 'mercurial', 'simple', 'env', 'null')。默认为 'auto'
*DEALER_PARAMS* — 后端参数

用法
^^^^^

在视图中：

from flask import Flask, g
from dealer.contrib.flask import Dealer

app = Flask('test')
Dealer(app)
assert app.revision

@app.route('/')
def usage_in_view()
return g.revision


在模板中：

<link href="/test.css?{{ REVISION }}" rel="stylesheet" type="text/css" media="screen" />

Pyramid 支持
---------------

::

config.include('dealer.contrib.pyramid')

::

def myview(request)
revision = request.registry.dealer.revision
tag = request.registry.dealer.tag

在模板中

::

修订版：{{DEALER_REVISION}}
标签：{{DEALER_TAG}}


Heroku 支持
-------------

设置
^^^^^^^^

*DEALER_TYPE* = 'env'
*DEALER_PARAMS*
*revision_env_keyname* - 修订版的变量名（默认：DEALER_REVISION）
*tag_env_keyname* - 标签的变量名（默认：DEALER_TAG）

用法
^^^^^

在环境变量中设置您的修订版和标签值。
例如在 Heroku.com 上：
::
heroku config:set DEALER_REVISION='3ffb6b6'
heroku config:set DEALER_TAG=v1_1

之后，按照上述说明使用 dealer。


.. _bagtracker

错误跟踪器
===========

如果您有任何建议、错误报告或
烦恼，请向 https://github.com/klen/Dealer/issues 的问题跟踪器报告
。


.. _contributing

贡献
============

dealer 的开发在 github 上进行：https://github.com/klen/dealer


.. _contributors

贡献者
=============

* klen_ (Kirill Klenov)


.. _license

许可
=======

在 `BSD 许可证`_ 下许可。


.. _links

.. _BSD 许可证: http://www.linfo.org/bsdlicense.html
.. _klen: http://klen.github.com/
.. _SCM: http://en.wikipedia.org/wiki/Source_Control_Management
.. _Git: http://en.wikipedia.org/wiki/Git_(software)
.. _Mercurial: http://en.wikipedia.org/wiki/Mercurial
.. |logo| image:: https://raw.github.com/klen/dealer/develop/docs/_static/logo.png
:width: 100

关键词：mercurial,git,静态,修订版,django,flask
平台：任何
分类器：开发状态 :: 4 - 测试版
分类器：目标受众 :: 开发者
分类器：目标受众 :: 系统管理员
分类器：自然语言 :: 俄语
分类器：自然语言 :: 英语
分类器：许可证 :: OSI 认可 :: BSD 许可证
分类器：操作系统 :: 不依赖操作系统
分类器：编程语言 :: Python
分类器：编程语言 :: Python :: 3.5
分类器：环境 :: 控制台