{
    "info": {
        "author": "Keryn Knight",
        "author_email": "django-templateselector@kerynknight.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Framework :: Django",
            "Framework :: Django :: 1.11",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "django-templateselector\n=======================\n\n:author: Keryn Knight\n:version: 0.2.5\n\n.. |travis_stable| image:: https://travis-ci.org/kezabelle/django-template-selector.svg?branch=0.2.5\n  :target: https://travis-ci.org/kezabelle/django-template-selector\n\n.. |travis_master| image:: https://travis-ci.org/kezabelle/django-template-selector.svg?branch=master\n  :target: https://travis-ci.org/kezabelle/django-template-selector\n\n==============  ======\nRelease         Status\n==============  ======\nstable (0.2.5)  |travis_stable|\nmaster          |travis_master|\n==============  ======\n\n\n.. contents:: Sections\n   :depth: 2\n\nWhat it does\n------------\n\nProvides a new model field, ``fields.TemplateField`` which allows for selection\nof a specific `Django`_ template using a nice form field (``fields.TemplateChoiceField``)\nand a nicer widget (``widgets.TemplateSelector``) than the standard ``<select>`` dropdown.\n\nExample\n^^^^^^^\n\nBelow is a screenshot of the admin widget, without any thumbnails set up for\neach template, because I'm too lazy for that.\n\n.. image:: https://raw.github.com/kezabelle/django-template-selector/master/screenshot.png\n    :alt: Example\n\nUse case\n--------\n\nImagine you have a ``Page`` model, and you want to allow admins or page authors\nto choose from a range of templates for the page to use, you could do this::\n\n  from django.db import models\n  from templateselector.fields import TemplateField\n\n  class MyPage(models.Model):\n    title = models.CharField(max_length=100)\n    # ...\n    template = TemplateField(match='^myapp/mypage/layouts/.+\\.html$')\n\nwhich would allow them to select any HTML file Django could find in the\nappropriate directory.\n\n\nAvailable functionality\n-----------------------\n\nThese fields are really the only public API. There's obviously other stuff, if you\ncare to rummage around.\n\n``TemplateField``\n^^^^^^^^^^^^^^^^^\n\nExtends CharField, and requires a ``match`` argument which ought to be a\nstring version of a regular expression. The ``match`` will be used to filter\nthe possible choices. Optionally also takes a ``display_name`` argument, which\nis a callable (or ``dotted.string.path.to.one``) that takes a given\nstring (the selected template path) and returns a nice name for it. The\nnice name is available as ``get_<fieldname>_display``, `for consistency with Django`_\n\nThe default form field for ``TemplateField`` is ...\n\n``TemplateChoiceField``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nHas the same arguments as ``TemplateField``, and can be used independently\nin all forms if you want to not use the model field.\nThe form field, when rendered with the ``TemplateSelector`` widget, will try\nand show a preview image for each template, by attempting to load a ``100W x 120H``\nimage from your staticfiles.\nGiven a template name of\n``path/to/template.htm`` it will try and load ``path/to/template.htm.png`` prefixed\nby whatever your ``STATIC_URL`` is. If no file exists, a placeholder image is\nshown as a fallback.\n\nBoth this and the ``TemplateField`` make use of...\n\n``nice_display_name``\n^^^^^^^^^^^^^^^^^^^^^\n\nThis function is the default callable for the ``display_name`` arguments on\nthe ``TemplateField`` and ``TemplateChoiceField``, it tries to provide some\nflexibility and sensisble defaults; specifically:\n\n* If your project defines a ``TEMPLATESELECTOR_DISPLAY_NAMES`` setting which\n  is a dictionary like ``{'path/to/template.html': \"my awesome template\"}`` then\n  the name ``\"my awesome template\"`` will be shown by preference.\n* If not set, or no key match is found, the function will take the *file name*\n  (not the path!) without *any extension* and will attempt to make a pretty, readable\n  name of it by replacing most non-alphabet characters with spaces, so\n  the template ``test/app/hello_world.html`` would become ``Hello world``\n\nSupported Django versions\n-------------------------\n\nThe tests are run against Django 1.11 on Python 2.7, and 3.5.\nThe widget uses the Django 1.11 template-based-rendering, so won't work on\nprevious versions. Possibly it'll just default back to a normal radiobox? I dunno.\n\n\nInstallation and usage\n----------------------\n\nInstallation\n^^^^^^^^^^^^\n\nYou can use `pip`_ to install the ``0.2.5`` version from `PyPI`_::\n\n    pip install django-templateselector==0.2.5\n\nOr you can grab it from  `GitHub`_  like this::\n\n  pip install -e git+https://github.com/kezabelle/django-template-selector.git#egg=django-template-selector\n\nConfiguration\n^^^^^^^^^^^^^\n\nTo get the ``TemplateSelector`` widget to display correctly, you *will* need to\nadd ``templateselector`` to your project's ``INSTALLED_APPS``.\n\nYou may also wish to configure ``TEMPLATESELECTOR_DISPLAY_NAMES = {}`` to provide\nnice names (see `nice_display_name`_)\n\nUsage\n^^^^^\n\nFor using the  `TemplateField`_, try something like this::\n\n  from django.db.models import Model\n  from templateselector.fields import TemplateField\n\n  class MyPage(models.Model):\n    template = TemplateField(match='^myapp/mypage/layouts/.+\\.html$')\n\nFor using the `TemplateChoiceField`_ without using the Model field, you'd\ndo something like::\n\n    from django.forms import Form\n    from templateselector.fields import TemplateChoiceField\n\n    class MyForm(Form):\n        field = TemplateChoiceField(match=\"^myapp/[0-9]+.html$\")\n\nTo get the widget's CSS, don't forget to use ``{{ form.media }}`` in your template!\n\nAltering the widget choice size\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you'd like to modify the dimensions used for each option in the widget (eg:\nyou have landscape template thumbnails instead of portrait) you'll need to\noverride the following CSS classes::\n\n    .templateselector-list-item {\n        width: ???;\n    }\n    .templateselector-label input {\n        top: ???;\n    }\n    .templateselector-thumb {\n        width: ???;\n        height: ???;\n    }\n\nYou can probably use the ``#id_FIELDNAME`` for a given field to provide the\nnecessary specificity.\n\nYou may need to provide a wrapper element if you re-use the same model/form\nattribute name (eg: ``{{ myform.selected_file }}``) for multiple things with\ndifferent dimensions::\n\n    <!-- target with\n    .myform-wrapper #id_selected_file .templateselector-list-item\n    etc -->\n    <div class=\"myform-wrapper\">{{ myform.selected_file }}</div>\n\n    <!-- target with\n    .myapp-wrapper #id_selected_file .templateselector-thumb\n     etc -->\n    <div class=\"myapp-wrapper\">{{ mymodelform.selected_file }}</div>\n\nRunning the tests\n^^^^^^^^^^^^^^^^^\n\nIf you have a cloned copy, you can do::\n\n  python setup.py test\n\nIf you have tox, you can just do::\n\n  tox\n\nRunning the demo\n^^^^^^^^^^^^^^^^\n\nA barebones demo is provided. It assumes you're using something like `virtualenv`_ and\n`virtualenvwrapper`_ but you can probably figure it out otherwise::\n\n    mktmpenv --python=`which python3`\n    pip install -e git+https://github.com/kezabelle/django-template-selector.git#egg=django-templateselector\n\nThen probably::\n\n    cd src/django-templateselector\n    python demo_project.py runserver\n\nThe index page ``/`` will show you a normal version of the selection widget,\nwhile ``/admin/tests/mymodel/add/`` will show the slightly customised version\nfor the standard `Django`_ admin.\n\nThe license\n-----------\n\nIt's the `FreeBSD`_. There's should be a ``LICENSE`` file in the root of the repository, and in any archives.\n\n.. _Django: https://www.djangoproject.com/\n.. _GitHub: https://github.com/\n.. _FreeBSD: http://en.wikipedia.org/wiki/BSD_licenses#2-clause_license_.28.22Simplified_BSD_License.22_or_.22FreeBSD_License.22.29\n.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/\n.. _virtualenv: https://virtualenv.pypa.io/en/stable/\n.. _pip: https://pip.pypa.io/en/stable/\n.. _PyPI: https://pypi.python.org/pypi\n.. _for consistency with Django: https://docs.djangoproject.com/en/stable/ref/models/instances/#django.db.models.Model.get_FOO_display\n\n\n----\n\nCopyright (c) 2017, Keryn Knight\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n----\n\nChange history for django-templateselector\n------------------------------------------\n\n0.2.5\n^^^^^^\n* |FIX| Added ``:focus`` visual styles so that keyboard navigation through a form\n  including the widget may now indicate when selecting items.\n\n0.2.4\n^^^^^^\n* |NEW| Added a `system check`_ to ensure that the templates and styles are\n  able to be loaded.\n\n\n0.2.3\n^^^^^^\n* |FIX| Change the model level field validation (``TemplateField(match=...)`` to\n  forcibly check the given value matches the regex, in addition to checking\n  whether the given value exists in one of the template loaders.\n* |META| Still trying to master automatic deployment from Travis. One day I'll\n  get sdist working again!\n\n0.2.2\n^^^^^^\n* |META| Still trying to master automatic deployment from Travis. No\n  functionality change since ``0.2.0``\n\n\n0.2.1\n^^^^^^\n* |META| Automatic deployment of new releases from Travis mostly worked, but the\n  ``sdist`` is in poor shape (see commit ``44ad2a1542f2f61a73de84e0f7213bccfdb6f265``)\n  so I've disabled that for now. Wheels are better anyway, right? No\n  functionality change since ``0.2.0``\n\n\n0.2.0\n^^^^^^\n\n* |FIX| prevent the \"same\" template showing up more than once in the\n  widget, which wouldn't be possible when using ``get_template`` (`#1`_)\n* |NEW| If the form field (``TemplateChoiceField``) has only **one** valid template\n  option, and the form is unbound (ie: its an **add** form or whatever) then\n  pre-select the valid choice. Only happens if the field has ``required=True``\n* |NEW| using the ``get_<fieldname>_display`` as a value in a ```ModelAdmin.list_display``\n  will now allow for sorting by the underlying value in the database. (`#2`_)\n* |NEW| if the ``<fieldname>`` is used as part of a ``ModelAdmin.list_filter`` it will\n  show the nice display names of any used templates, rather than their internal\n  path representation. (`#3`_)\n\n0.1.1\n^^^^^^\n* |META| First release on PyPI.\n\n0.1.0\n^^^^^\n* |META| Initial development.\n\n\n.. |FIX| replace:: **BUGFIX:**\n.. |NEW| replace:: **FEATURE:**\n.. |META| replace:: **MISC:**\n.. _#1: https://github.com/kezabelle/django-template-selector/issues/1\n.. _#2: https://github.com/kezabelle/django-template-selector/issues/2\n.. _#3: https://github.com/kezabelle/django-template-selector/issues/3\n.. _system check: https://docs.djangoproject.com/en/stable/topics/checks/\n\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/kezabelle/django-template-selector",
        "keywords": "django templateselector widget model form field",
        "license": "BSD License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "django-templateselector",
        "package_url": "https://pypi.org/project/django-templateselector/",
        "platform": "",
        "project_url": "https://pypi.org/project/django-templateselector/",
        "project_urls": {
            "Homepage": "https://github.com/kezabelle/django-template-selector"
        },
        "release_url": "https://pypi.org/project/django-templateselector/0.2.5/",
        "requires_dist": [
            "Django (>=1.8)",
            "scandir (>=1.5); python_version<'3'"
        ],
        "requires_python": "",
        "summary": "Provides a model field and form field for allowing users to select a template file",
        "version": "0.2.5"
    },
    "last_serial": 3152982,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f9d48490c286f64b1e020d91db295403",
                    "sha256": "abf1b5281b8b87ac67708a71321342446dbc5378da4b64b5df5bc4b91284cdf5"
                },
                "downloads": -1,
                "filename": "django_templateselector-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f9d48490c286f64b1e020d91db295403",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 21060,
                "upload_time": "2017-07-19T19:39:59",
                "url": "https://files.pythonhosted.org/packages/60/b2/7f441d9e860e3a1d4d8ecc3e3d48372c50a5fbbedb7decb6b817bb9451d5/django_templateselector-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a9a322da707d0851ec4bf270ee963298",
                    "sha256": "26f890cf4a60e5b5717c205d8e6612d5ac050377445a68ca2fa39e435759f127"
                },
                "downloads": -1,
                "filename": "django-templateselector-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "a9a322da707d0851ec4bf270ee963298",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27697,
                "upload_time": "2017-07-19T19:40:02",
                "url": "https://files.pythonhosted.org/packages/24/f2/056af91171a67f97900930d6b0192fef232d9ecbe0b3760ab0fc1d93f649/django-templateselector-0.1.1.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d9c43beb9b12631ee785487c70b384b5",
                    "sha256": "3a73f0b870ef9a46f24f85b0f8018fe7fbbb3a5f45f319d2857e15188181317a"
                },
                "downloads": -1,
                "filename": "django_templateselector-0.2.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d9c43beb9b12631ee785487c70b384b5",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 25097,
                "upload_time": "2017-08-23T10:55:44",
                "url": "https://files.pythonhosted.org/packages/e0/9b/4d202a0e2485e922baa8239dadd6f91209bd45dc27e6496c1d489ddc3ada/django_templateselector-0.2.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e30a5d9f958c14c412eb2655956c2300",
                    "sha256": "0b104c3dd5bee5c4c63d2a60b48d1792988d006f8096785bcc113c8a9240d78d"
                },
                "downloads": -1,
                "filename": "django-templateselector-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "e30a5d9f958c14c412eb2655956c2300",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2878941,
                "upload_time": "2017-08-23T10:55:47",
                "url": "https://files.pythonhosted.org/packages/15/1c/2747dece29afa6a6dd085c3b3fc8eef593e0e4a87038d321cfb7e4fe8940/django-templateselector-0.2.0.tar.gz"
            }
        ],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "18a225b3f6e96e818b776ca36235afba",
                    "sha256": "dc50bb1d6c3e9abc8aad6cd8d6916f885d353256ebcbf45cc7951cd0ee59e9a0"
                },
                "downloads": -1,
                "filename": "django_templateselector-0.2.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "18a225b3f6e96e818b776ca36235afba",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 25496,
                "upload_time": "2017-08-23T12:56:12",
                "url": "https://files.pythonhosted.org/packages/cf/22/de5a981feb8d6d405a961b60543fa2e21a42652f55f77f046450638decf1/django_templateselector-0.2.2-py2.py3-none-any.whl"
            }
        ],
        "0.2.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "37131268013c298e18fc4213b9a38421",
                    "sha256": "e1243c663258fddcd89e26378bb4ff820a2f8439684dbaf6424be2d60400efcc"
                },
                "downloads": -1,
                "filename": "django_templateselector-0.2.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "37131268013c298e18fc4213b9a38421",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 26870,
                "upload_time": "2017-08-30T20:14:13",
                "url": "https://files.pythonhosted.org/packages/13/1d/db22556323c2adaa0c0af0c826bfceb46db7c4205f0f8e70df2801d4a680/django_templateselector-0.2.4-py2.py3-none-any.whl"
            }
        ],
        "0.2.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f764c14455318b7719d8cfe82ec23ec6",
                    "sha256": "c5a406aa3cd5d130d074e58ef618e940914a19622d44747b52911552b2f37f0f"
                },
                "downloads": -1,
                "filename": "django_templateselector-0.2.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f764c14455318b7719d8cfe82ec23ec6",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 27090,
                "upload_time": "2017-09-06T09:58:01",
                "url": "https://files.pythonhosted.org/packages/6a/c7/2e9c1697ee7dbd908862c74060e3acb20a7ad93f5fd00e1a281cea174b6e/django_templateselector-0.2.5-py2.py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f764c14455318b7719d8cfe82ec23ec6",
                "sha256": "c5a406aa3cd5d130d074e58ef618e940914a19622d44747b52911552b2f37f0f"
            },
            "downloads": -1,
            "filename": "django_templateselector-0.2.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f764c14455318b7719d8cfe82ec23ec6",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 27090,
            "upload_time": "2017-09-06T09:58:01",
            "url": "https://files.pythonhosted.org/packages/6a/c7/2e9c1697ee7dbd908862c74060e3acb20a7ad93f5fd00e1a281cea174b6e/django_templateselector-0.2.5-py2.py3-none-any.whl"
        }
    ]
}