{ "info": { "author": "hoatle", "author_email": "hoatlevan@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Browsers" ], "description": "teracy-django-html5-boilerplate\n===============================\n\n``teracy-django-html5-boilerplate`` is a Django wrapper application that includes `html5-boilerplate`_\nassets and provides ``base.html`` for starting any web application with ``html5-boilerplate``.\n\nThe project mission is to port html5-boilerplate to Django development so that every Django project\ncould take and use it with ease, flexibility and customization by its needs.\n\nContinuous Integration\n----------------------\n\n.. image:: https://badge.fury.io/py/teracy-django-html5-boilerplate.png\n :target: https://badge.fury.io/py/teracy-django-html5-boilerplate\n\n.. image:: https://pypip.in/d/teracy-django-html5-boilerplate/badge.png\n :target: https://crate.io/packages/teracy-django-html5-boilerplate?version=latest\n\n.. image:: https://coveralls.io/repos/teracy-official/django-html5-boilerplate/badge.png?branch=develop\n :alt: Coverage Status\n :target: https://coveralls.io/r/teracy-official/django-html5-boilerplate?branch=develop\n\n.. image:: https://travis-ci.org/teracy-official/django-html5-boilerplate.png?branch=develop\n :alt: Travis CI\n :target: https://travis-ci.org/teracy-official/django-html5-boilerplate\n\n.. image:: https://ci.teracy.org/buildStatus/icon?job=django-html5-boilerplate-develop\n :alt: Teracy CI\n :target: https://ci.teracy.org/job/django-html5-boilerplate-develop/\n\n\nUsage\n-----\n\n**1. Application Adding**\n\nAdd \"teracy.html5boilerplate\" to your ``INSTALLED_APPS`` setting like this:\n::\n\n INSTALLED_APPS += (\n 'teracy.html5boilerplate',\n )\n\n**2. base.html Extending**\n\nExtend the ``base.html`` like this:\n::\n\n {% extends 'html5boilerplate/base.html' %}\n\n**3. Overriding**\n\nAssume that `django-boilerplate`_ is used.\n\n- Overriding ``static`` by creating ``static/html5boilerplate/`` containing ``favicon.ico`` and\n ``apple-touch-icon-precomposed.png``.\n\n- Overriding ``templates`` overriding by creating ``templates/html5boilerplate/`` containing\n ``crosssdomain.xml``, ``humans.txt`` and ``robots.txt``.\n\n\nInstallation\n------------\n\nAdd ``teracy-django-html5-boilerplate`` application into your requirements file:\n::\n\n teracy-django-html5-boilerplate\n\nOr with ``pip``:\n::\n\n $ pip install teracy-django-html5-boilerplate\n\nOr with ``setuptools``:\n\nDownload the source code at https://github.com/teracy-official/django-html5-boilerplate and:\n::\n\n $ python setup.py install\n\nTo download the latest snapshot development version with ``pip``:\n::\n\n pip install -i http://pypi.teracy.org/teracy/public/+simple/ teracy-django-html5-boilerplate --pre\n\n\nConfiguration\n-------------\n\n``teracy.html5boilerplate.context_processors.page`` context processor is provided to process\n``page.author``, ``page.copyright`` and ``page.ga_id`` from django settings file like the\nconfiguration below:\n::\n\n TEMPLATE_CONTEXT_PROCESSORS += (\n 'teracy.html5boilerplate.context_processors.page',\n )\n\n SITE_AUTHOR = 'Teracy'\n SITE_COPYRIGHT = 'Teracy, Inc.'\n SITE_GA_ID = 'UA-42868657-2'\n\nTo include source code files instead of minified ones, add ``django.core.context_processors.debug``\nto ``TEMPLATE_CONTEXT_PROCESSORS`` on **debug mode**.\n::\n\n TEMPLATE_CONTEXT_PROCESSORS += (\n 'django.core.context_processors.debug',\n )\n\n\n\nContext Variables\n-----------------\n\nContext variables are expected to be included in a dictionary variable named: \"page\".\n::\n\n page.lang - \"lang\" attribute for tag. Default: \"en\".\n page.dir - \"dir\" attribute for tag. Default: \"ltr\".\n page.charset - meta charset value. Default: \"utf-8\".\n page.x_ua_compatible - \"content\" for http-equiv=\"X-UA-Compatible\" meta tag. Default: \"IE=edge,chrome=1\".\n page.description - \"content\" for \"description\" name meta tag. Default: None.\n page.keywords - \"content\" for \"keywords\" name meta tag. Default: None.\n page.author - \"content\" for \"author\" name meta tag. Default: None.\n page.copyright - \"content\" for \"copyright\" name meta tag. Default: None.\n page.title - value for tag. Default: None.\n page.ga_id - id for google analytics. Default: None.\n\n\nBlocks\n------\n\nConventions:\n::\n\n [block_name]\n [child_block_name]\n\nThe page structure is defined as following:\n::\n\n <html>\n <head>\n [meta]\n [meta_viewport]\n [meta_extra]\n [title]\n [apple_touch_icon]\n [favicon]\n [stylesheet]\n [javascript]\n </head>\n <body class=[body_class]>\n [browser_outdated]\n [body_content]\n [body_extra]\n [jquery_loader]\n [js_app_loader]\n [google_analytics]\n </body>\n </html>\n\nBy default:\n\n* [meta]: includes basic meta data of a page.\n\n* [meta_extra]: should be used to provide more meta data for the page (for example: open graph,\n twitter cards, apple app id, etc.).\n\n* [title]: should provide page.title context to set the page's title.\n\n* [apple_touch_icon]: Place apple-touch-icon.png in the root directory or set it explict here on\n this block. Default link to ``html5boilerplate/apple-touch-icon-precomposed.png``.\n\n* [favicon]: Place favicon.ico in the root directory or set it explicit here on this block.\n Default link to ``html5boilerplate/favicon.ico``.\n\n* [stylesheet]: Load 'html5boilerplate/css/normalize.css' and 'html5boilerplate/css/main.css' by\n default.\n\n* [javascript]: Load 'html5boilerplate/js/vendor/modernizr-2.6.2.min.js' by default.\n\n* [body_class]: Set CSS class to <body> tag.\n\n* [browser_outdated]: Outdated message to be displayed when IE6 and below are used to access the page.\n\n* [body_content]: The main content block.\n\n* [body_extra]: Includes 2 children blocks: [jquery_loader] and [google_analytics].\n\n* [jquery_loader]: Load jquery.\n\n* [google_analytics]: Setup google analytics code if \"page.ga_id\" context is provided.\n\n\nContributing\n------------\n\n1. File issues at https://issues.teracy.org/browse/DJHBP\n\n2. Follow workflow at http://dev.teracy.org/docs/develop/workflow.html\n\n3. Notices:\n\nMake sure to resolve the dependency requirements:\n::\n\n $ make resolve\n\nMake sure to check the coding style:\n::\n\n $ make check-style\n\nMake sure to run tests:\n::\n\n $ make test\n\nMake sure to check the coverage report:\n::\n\n $ make report-coverage\n\n\nAuthors and contributors\n------------------------\n\n- Hoat Le: hoatle at teracy dot com\n\n\nLicense\n-------\n\nThe BSD 3-Clause License\n::\n\n Copyright (c) Teracy, Inc. and individual contributors.\n All rights reserved.\n\n Redistribution and use in source and binary forms, with or without modification,\n are permitted provided that the following conditions are met:\n\n 1. Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n 2. Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n 3. Neither the name of Teracy, Inc. nor the names of its contributors may be used\n to endorse or promote products derived from this software without\n specific prior written permission.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR\n ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\n ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n.. _html5-boilerplate: http://html5boilerplate.com\n\n.. _django-boilerplate: https://github.com/teracy-official/django-boilerplate", "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/teracy-official/django-html5-boilerplate", "keywords": "python,django,html5-boilerplate", "license": "BSD License", "maintainer": null, "maintainer_email": null, "name": "teracy-django-html5-boilerplate", "package_url": "https://pypi.org/project/teracy-django-html5-boilerplate/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/teracy-django-html5-boilerplate/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/teracy-official/django-html5-boilerplate" }, "release_url": "https://pypi.org/project/teracy-django-html5-boilerplate/0.3.0/", "requires_dist": null, "requires_python": null, "summary": "html5-boilerplate Django wrapper application", "version": "0.3.0" }, "last_serial": 919168, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "f2e98b5a4757f59fde476568c961a635", "sha256": "22744e4070831212729f580bdb682205ad2d207c3d697ecd5a85baffe769ba2f" }, "downloads": -1, "filename": "teracy-django-html5-boilerplate-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f2e98b5a4757f59fde476568c961a635", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 54470, "upload_time": "2013-08-20T11:29:52", "url": "https://files.pythonhosted.org/packages/7a/8e/57823b56d5a81a0b5c4f747bf2654caf72a86b4e95f19a733cc63a1a82ec/teracy-django-html5-boilerplate-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "e79b9d03758834793bdc5c97f3ab0ed2", "sha256": "ce15f608384cd41e73f31b3368d1e50a38518d864ea9bcd8a68449bc02fe9e2e" }, "downloads": -1, "filename": "teracy-django-html5-boilerplate-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e79b9d03758834793bdc5c97f3ab0ed2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 155013, "upload_time": "2013-09-14T20:56:59", "url": "https://files.pythonhosted.org/packages/ba/61/42c2903481296cd41201fe2f6c6398ecdbd8bb4328b24e95db15fadf9c5d/teracy-django-html5-boilerplate-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "1f057a30fee955fa857363d5e66900a3", "sha256": "341c2dbfd06629d24f9b03e470fe42b7008d51c1c17c882c1cd8dd8bc1a988f8" }, "downloads": -1, "filename": "teracy-django-html5-boilerplate-0.3.0.tar.gz", "has_sig": false, "md5_digest": "1f057a30fee955fa857363d5e66900a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 155924, "upload_time": "2013-11-14T08:45:03", "url": "https://files.pythonhosted.org/packages/c8/5c/6262daf4d4e3149b446d78165a10caf18597c1f9e52d5f3962cb1c6cd77c/teracy-django-html5-boilerplate-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1f057a30fee955fa857363d5e66900a3", "sha256": "341c2dbfd06629d24f9b03e470fe42b7008d51c1c17c882c1cd8dd8bc1a988f8" }, "downloads": -1, "filename": "teracy-django-html5-boilerplate-0.3.0.tar.gz", "has_sig": false, "md5_digest": "1f057a30fee955fa857363d5e66900a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 155924, "upload_time": "2013-11-14T08:45:03", "url": "https://files.pythonhosted.org/packages/c8/5c/6262daf4d4e3149b446d78165a10caf18597c1f9e52d5f3962cb1c6cd77c/teracy-django-html5-boilerplate-0.3.0.tar.gz" } ] }