未知
djcroco的Python项目详细描述
djcroco是自定义的Django模型字段 添加对Crocodoc API的支持。
它的行为就像标准的FileField 所以您仍然可以使用它的大部分属性(例如name,size,url 等)同时有额外的玩鳄鱼皮。
djcroco由Incuna(一家很棒的公司)支持 我为之工作!.
安装
要安装djcroco,只需运行:
pip install djcroco
包含在urls.py:
url(r'', include('djcroco.urls')),
在settings.py:
中定义Crocodoc API令牌CROCO_API_TOKEN = '<api_token>'
或者作为env变量:
export CROCO_API_TOKEN='<api_token>'
当使用url的可选参数时(请参见下面的详细信息)-然后 您需要将djcroco添加到INSTALLED_APPS:
INSTALLED_APPS += ('djcroco',)
并将其模板标记加载到要在中使用的模板中:
{% load croco_tags %}
用法
在要扩展的模型中定义字段:
fromdjango.dbimportmodelsfromdjcroco.fieldsimportCrocoFieldclassExample(models.Model):name=models.CharField(max_length=255)document=CrocoField()def__unicode__(self):returnself.name
自定义缩略图大小
您可以像这样传递thumbnail_size:
document=CrocoField(thumbnail_size=(150,150))
其中元组表示为(宽度,高度)。
如果不传递自定义缩略图大小,将使用默认值(100x100)。 缩略图的最大维度是^ {STR 1 } $300 x300 。
缩略图缓存
默认情况下,每次呈现模板时都会生成缩略图, 这包括为每个缩略图点击crocodoc api。可能是时候了 如果你在一页上有很多东西,那就太贵了。为了避免上述问题 可以指向一个字段,在该字段中缩略图将被保存并从此处提供服务 下一次。
classExample(models.Model):name=models.CharField(max_length=255)document=CrocoField(thumbnail_field='my_thumbnail')my_thumbnail=models.ImageField(upload_to='whatever/')
注意thumbnail_field必须是ImageField类型。
渲染awesomeness
文件
{{ obj.document.name }}
返回文档的名称。
{{ obj.document.size }}
返回文档的大小(字节)。
{{ obj.document.size_human }}
返回文档的可读大小(例如1.3 MB)。
{{ obj.document.type }}
返回文档的类型(扩展名)。
{{ obj.document.uuid }}
返回文档的uuid(注意:每个crocodoc文档都有唯一的id)。
网址
{{ obj.document.url }}
返回文档的URL,以便可以直接查看。
{{ obj.document.content_url }}
返回包装在HttpResponse对象中的文档的url。
url和content_url都可以用optional parameters扩展。
{{ obj.document.url|editable:"true"|user_id:"1"|user_name:"admin" }}
editableparam允许用户在查看文档时创建批注和注释。 默认值:false
user_id和user_name将显示在查看器中,以便将注释和注释属性化为其作者。如果editable为true,则必需
{{ obj.document.url|user_filter:"1,2,3" }}
限制显示哪些用户的批注和注释。可能的值是:all,none,或者用户id的逗号分隔列表。默认值:全部
note:user_filter是crocodoc的filter的重命名版本,以便在django模板系统中工作。
支持的parameters的完整列表。
下载
{{ obj.document.download_document }}
返回PDF格式的原始文档。
{{ obj.document.download_document|annotated:"true" }}
返回带有批注的原始文档。默认值:false
{{ obj.document.download_document|user_filter:"1,2,3" }}
返回原始文档,其批注仅限于给定用户。 可能的值是:all,none,或者用户id的逗号分隔列表。默认值:全部
{{ obj.document.download_thumbnail }}
以PNG格式返回文档第一页的缩略图。
{{ obj.document.download_thumbnail|size:"99x99" }}
与download_thumbnail相同,缩略图的自定义尺寸格式为{width}x{height}。最大尺寸允许NS为300x300。默认值:100x100
{{ obj.document.download_text }}
返回文档的全文。 注意:只有当您的Crocodoc帐户有文本时,此方法才可用 已启用提取。