{ "info": { "author": "Philipp Bosch", "author_email": "hello@pb.io", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "django-sirtrevor\n================\n\n**django-sirtrevor** is a simple Django app that provides a content editing\nwidget based on the fantastic `Sir Trevor`_ project.\n\n\nQuick start\n-----------\n\n1. Install django-sirtrevor::\n\n pip install django-sirtrevor\n\n2. Add ``sirtrevor`` to your INSTALLED_APPS setting like this::\n\n INSTALLED_APPS = (\n ...\n 'sirtrevor',\n )\n\n3. Add sir trevor urls::\n\n url(r'^sirtrevor/', include('sirtrevor.urls')),\n\n4. Create a model that makes use of ``SirTrevorField``::\n\n from django.db import models\n from sirtrevor.fields import SirTrevorField\n\n class MyModel(models.Model):\n ...\n content = SirTrevorField()\n ...\n\n5. Now you can \u2026\n\n - see it in action in the Django admin\n - create a ``ModelForm`` from your model\n - create a plain ``Form`` and use ``sirtrevor.forms.SirTrevorFormField``\n - use ``sirtrevor.widgets.SirTrevorWidget`` as a widget replacement for a\n ``Textarea``\n\n\nConfiguration\n-------------\n\n`Sir Trevor`_ has a few `configuration options`_. You can customize most of\nthem project-wide in your ``settings.py`` or some on a per-widget basis as\n``kwargs`` for ``SirTrevorWidget``.\n\n\n**Available options** (``CONFIGURATION_SETTINGS`` / ``widget_kwargs``):\n\n\n``SIRTREVOR_BLOCK_TYPES`` / ``st_block_types``\n A list of block types to use with the editor.\n Defaults to ``['Text', 'List', 'Quote', 'Image', 'Video', 'Tweet', 'Heading']``\n\n``SIRTREVOR_DEFAULT_TYPE`` / ``st_default_type``\n The default block to start the editor with.\n Defaults to ``None``\n\n``SIRTREVOR_BLOCK_LIMIT`` / ``st_block_limit``\n The overall total number of blocks that can be displayed.\n Defaults to ``0``\n\n``SIRTREVOR_BLOCK_TYPE_LIMITS`` / ``st_block_type_limits``\n Limit on the number of blocks that can be displayed by its type.\n Defaults to ``{}``\n\n``SIRTREVOR_REQUIRED`` / ``st_required``\n Mandatory block types that are required for validatation.\n Defaults to ``None``\n\n``SIRTREVOR_UPLOAD_URL`` / ``st_upload_url``\n URL for AJAX image uploads.\n Defaults to ``/sirtrevor/attachments/`` (depending on where you include\n django-sirtrevor's URLs in ``urls.py``)\n\n``SIRTREVOR_UPLOAD_PATH``\n Path where to store uploaded images relative to ``MEDIA_ROOT``. (not\n configurable via widget kwargs)\n Defaults to ``attachments``\n\n``SIRTREVOR_ATTACHMENT_PROCESSOR``\n A string containing a dotted path to a function that will be run before\n saving an uploaded image. See `below`_ for more details. (not configurable via\n widget kwargs)\n Defaults to ``None``\n\n\nResizing Images\n---------------\n\nYou can resize uploaded images by implementing a function somewhere in your\ncode and pointing ``SIRTREVOR_ATTACHMENT_PROCESSOR`` to its location. The first\nargument will be the file object and the method must return a\n``SimpleUploadFile`` object.\n\nExample implemented in ``utils.py`` in an app called ``core``.\n``SIRTREVOR_ATTACHMENT_PROCESSOR`` set to ``core.utils.resize_attachment``::\n\n from PIL import Image\n from StringIO import StringIO\n from django.core.files.uploadedfile import SimpleUploadedFile\n\n\n def resize_attachment(file_):\n size = (1024, 9999)\n try:\n temp = StringIO()\n image = Image.open(file_)\n image.thumbnail(size, Image.ANTIALIAS)\n image.save(temp, 'jpeg')\n temp.seek(0)\n return SimpleUploadedFile(file_.name, temp.read(), content_type='image/jpeg')\n except Exception as ex:\n return file_\n\n\nCustom Blocks\n-------------\n\n*Sir Trevor* can be extended through `custom blocks`_. Starting with 0.2.1\n*django-sirtrevor* also has basic support for custom blocks.\n\nHere is a little step-by-step guide:\n\n**myapp/blocks.py**::\n\n from sirtrevor.blocks import BaseBlock\n\n class MyCustomBlock(BaseBlock):\n name = 'MyCustomName'\n\n class Media:\n js = ['sirtrevor/blocks/mycustomblock.js']\n\n\n**myapp/models.py**::\n\n import sirtrevor\n from .blocks import MyCustomBlock\n\n sirtrevor.register_block(MyCustomBlock)\n\n\n**myapp/static/sirtrevor/blocks/mycustomblock.js**::\n\n SirTrevor.Blocks.MyCustomName = SirTrevor.Block.extend({\n type: 'mycustomblock',\n // ...\n });\n\nPlease refer to *Sir Trevor*'s docs regarding `custom blocks`_ for details\nabout the JavaScript part of a custom block.\n\n\n**myapp/templates/sirtrevor/blocks/mycustomblock.html**::\n\n
\n \n
\n\n\n**settings.py**::\n\n # ...\n\n SIRTREVOR_BLOCK_TYPES = ['Text', '...', 'MyCustomName']\n\n # ...\n\n\nFor reference please check out `django-sirtrevor-file`_ which implements a\nsimple block type for file downloads.\n\n\n\nLicense\n-------\n\nMIT_\n\n\n.. _Sir Trevor: http://madebymany.github.io/sir-trevor-js/\n.. _MIT: http://philippbosch.mit-license.org/\n.. _configuration options: http://madebymany.github.io/sir-trevor-js/docs.html#2\n.. _key features: https://github.com/philippbosch/django-sirtrevor/issues/2\n.. _below: #resizing-images\n.. _custom blocks: http://madebymany.github.io/sir-trevor-js/docs.html#4\n.. _django-sirtrevor-file: https://github.com/philippbosch/django-sirtrevor-file", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/philippbosch/django-sirtrevor/", "keywords": null, "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "django-sirtrevor", "package_url": "https://pypi.org/project/django-sirtrevor/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-sirtrevor/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/philippbosch/django-sirtrevor/" }, "release_url": "https://pypi.org/project/django-sirtrevor/0.2.4/", "requires_dist": null, "requires_python": null, "summary": "A simple Django app that provides a model field and corresponding widget based on the fantastic Sir Trevor project", "version": "0.2.4" }, "last_serial": 1416802, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "de1ad67e61f002c7fd36afa59c253c46", "sha256": "76139f98918d17d679ee550c0b76a9c5fd3810e35fa506a7bfeecf42300a738c" }, "downloads": -1, "filename": "django-sirtrevor-0.1.0.tar.gz", "has_sig": false, "md5_digest": "de1ad67e61f002c7fd36afa59c253c46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 425517, "upload_time": "2014-01-15T14:17:39", "url": "https://files.pythonhosted.org/packages/41/1d/ec61d724ce594a9dcba01510a103cc65d0b5c5994d06433fd973f1514e1d/django-sirtrevor-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "d9e0f46ead346f0aed47729229955b69", "sha256": "7d51dbe9fcc542f8e01813124f55730ae2ab6511400643a46e287dee8014c571" }, "downloads": -1, "filename": "django-sirtrevor-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d9e0f46ead346f0aed47729229955b69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 426333, "upload_time": "2014-02-18T11:06:23", "url": "https://files.pythonhosted.org/packages/18/ae/8702a9602c7935fe4e98ef57fd5b9ef9df25995142e24cfb74e80e7bddc5/django-sirtrevor-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "22480c5585dc922ef4f407b100a5d9c1", "sha256": "7c2719d0c7f752d2127eeb12e40b8c5c3ff61ba5e7f8607150fd3de35af72494" }, "downloads": -1, "filename": "django-sirtrevor-0.1.2.tar.gz", "has_sig": false, "md5_digest": "22480c5585dc922ef4f407b100a5d9c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 426431, "upload_time": "2014-02-18T11:44:18", "url": "https://files.pythonhosted.org/packages/3c/c4/65998f528f632c677f6c58f7658a1eeb5be0cd1eced6f96f93a64fe135dc/django-sirtrevor-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "b2928bf5fd82e573d1e4cbc308ee53f0", "sha256": "d9011a06f19481be8cc3bb375cc014663f351f4a8b6bc914f70ba91f6f1f8fa9" }, "downloads": -1, "filename": "django-sirtrevor-0.1.3.tar.gz", "has_sig": false, "md5_digest": "b2928bf5fd82e573d1e4cbc308ee53f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 427254, "upload_time": "2014-03-17T19:51:12", "url": "https://files.pythonhosted.org/packages/e7/34/5a28b8cd85aa5ed70f2de8d2e02a11e2e5dac1ac1d0a6ca7bf7deab789dd/django-sirtrevor-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "f3397ad39a05869a89bec63ed4746bf4", "sha256": "eee2835c448a6ab503c0b20762e6b822a53f7873b2b3267f2ffd04ba0a1622ed" }, "downloads": -1, "filename": "django-sirtrevor-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f3397ad39a05869a89bec63ed4746bf4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 427641, "upload_time": "2014-03-18T00:57:37", "url": "https://files.pythonhosted.org/packages/a3/4b/d397602391de1c5b556320639611c7c2125b622612211ff0efe3bf6ce11a/django-sirtrevor-0.1.4.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "86cb43b4110bd3444ab17ebb8ff38791", "sha256": "5469eb7946268d65c1b626dc678b195bea1db05aa97f0a627d880754ad9012f6" }, "downloads": -1, "filename": "django-sirtrevor-0.2.0.tar.gz", "has_sig": false, "md5_digest": "86cb43b4110bd3444ab17ebb8ff38791", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 429847, "upload_time": "2014-04-03T10:55:00", "url": "https://files.pythonhosted.org/packages/bd/cb/deb55757e35cbd11cf90abfa0239c769c0b7a5556e243225c982d1f06b49/django-sirtrevor-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "46a51e37bfe0a3f4de82fe0d29f58b03", "sha256": "2e26e99b15e58e223f96ae641e806fceb1b68948d00ed58a553a34d5d20bcda3" }, "downloads": -1, "filename": "django-sirtrevor-0.2.1.tar.gz", "has_sig": false, "md5_digest": "46a51e37bfe0a3f4de82fe0d29f58b03", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 430071, "upload_time": "2014-04-03T15:43:08", "url": "https://files.pythonhosted.org/packages/0c/30/8c0c492542e5bf831e9f7c9d7299f1efe3836b1e88a5d7197f17878b7f05/django-sirtrevor-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "91b78309ba6306b74ca4c2070e774781", "sha256": "057503f0269c71913ae758bbdbd54c1d7976e3c725afe710e1f7f493844ec6b7" }, "downloads": -1, "filename": "django-sirtrevor-0.2.2.tar.gz", "has_sig": false, "md5_digest": "91b78309ba6306b74ca4c2070e774781", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 430656, "upload_time": "2014-05-22T11:36:44", "url": "https://files.pythonhosted.org/packages/0b/56/7f56a1cdafb82bb4d5ad80e6d804eba583a42d4a0c105b082abaa94331d9/django-sirtrevor-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "da50e31aa601327a0206081f57e91a35", "sha256": "42549750a58e5e689171b8fb0dd40277d81c8af376a6df05b4c46ce713531750" }, "downloads": -1, "filename": "django-sirtrevor-0.2.3.tar.gz", "has_sig": false, "md5_digest": "da50e31aa601327a0206081f57e91a35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 430689, "upload_time": "2014-05-27T20:19:21", "url": "https://files.pythonhosted.org/packages/2a/a5/b912a1a3a167b754c2e37888de6389d9e718d8cc9ee5b0bec34e8585a853/django-sirtrevor-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "e1b2745f6316ef3f81b9b717e2d690b6", "sha256": "10965c27a9bcdc904c281735781579b2d2dd87c1f646c28f338922ab1754d96e" }, "downloads": -1, "filename": "django-sirtrevor-0.2.4.tar.gz", "has_sig": false, "md5_digest": "e1b2745f6316ef3f81b9b717e2d690b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 430664, "upload_time": "2015-02-09T21:48:15", "url": "https://files.pythonhosted.org/packages/0c/31/b7cbf1902dc42c011efff01e6f1fdc7b58615164ee7514c6987a96b700e0/django-sirtrevor-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e1b2745f6316ef3f81b9b717e2d690b6", "sha256": "10965c27a9bcdc904c281735781579b2d2dd87c1f646c28f338922ab1754d96e" }, "downloads": -1, "filename": "django-sirtrevor-0.2.4.tar.gz", "has_sig": false, "md5_digest": "e1b2745f6316ef3f81b9b717e2d690b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 430664, "upload_time": "2015-02-09T21:48:15", "url": "https://files.pythonhosted.org/packages/0c/31/b7cbf1902dc42c011efff01e6f1fdc7b58615164ee7514c6987a96b700e0/django-sirtrevor-0.2.4.tar.gz" } ] }