{ "info": { "author": "Tim Court", "author_email": "tctimmeh@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4" ], "description": "DC Django Base\n==============\n\nIncluded Libraries\n------------------\n\nThe following libraries are made available to your application by **dc-django-base**.\n\n**Python Libraries**:\n\n* django-widget-tweaks\n* django-allauth\n* django-gravatar2\n* selenium\n\n**Javascript**\n\n* bootstrap 3.3.2\n* jquery 2.1.3\n* jquery cookie 1.4.1\n* jquery form 3.51\n\nInstallation\n------------\n\nSettings\n````````\n\nStart the site's settings by importing the ``base_settings`` file::\n\n from dcbase.base_settings import *\n\nRefer to this file to see the complete list of settings that are included by default. The following are settings that your \nsite **must** provide:\n\n* BASE_DIR (typically ``os.path.dirname(os.path.dirname(__file__))``)\n* SECRET_KEY (source the production key from a secure place, **not** a text file in a public source repository)\n* ROOT_URLCONF\n* WSGI_APPLICATION\n* DATABASES\n* EMAIL_BACKEND (consider using ``django.core.mail.backends.console.EmailBackend`` for testing)\n\nAdd the site's apps to ``INSTALLED_APPS`` by prepending them to the base apps::\n\n INSTALLED_APPS = (\n 'some_app',\n 'allauth.socialaccount.providers.google',\n ) + INSTALLED_APPS\n\nOther \"list\" settings can be modified in a similar way. \n\nBecause the order of middleware is important it may be required to copy and modify the entire ``MIDDLEWARE_CLASSES`` setting\nto inject a new middleware class in the middle of the list.\n\nMultiple Settings\n~~~~~~~~~~~~~~~~~\n\nA project often needs to maintain multiple settings files. For example, a project may require different settings for it's\ndevelopment, staging, and production sites. Follow this pattern to allow easy switching between settings.\n\nFirst, create a ``settings_common.py`` file. Fill this file with settings that are common to all configurations. Normally,\nthis file would import ``dcbase.base_settings`` as described above and include settings like ``BASE_DIR``, ``ROOT_URLCONF``,\n``INSTALLED_APPS``, etc. For safety, **never** include a setting here that could expose the production site to danger, such as\n``SECRET_KEY`` or ``DEBUG = True``.\n\nCreate a settings file for each specific configuration. Include the common settings file (e.g. ``from .settings_common import *``)\nand add settings that are unique to the specific installation. For example, create a ``settings_dev.py`` for development settings and\n``settings_prod.py`` for production settings. This file will normally contain settings like ``SECRET_KEY``, ``DATABASES``,\n``ALLOWED_HOSTS``, etc. Be **very** careful how the production settings file is managed and versioned to avoid exposing sensitive\ninformation such as the secret key and database credentials.\n\nFinally, create a symlink to the specific settings file. For example, ``ln -s settings_prod.py settings.py``.\n\nUrls\n````\n\nInclude the following urls in the site's urlconf::\n\n url(r'', include('dcbase.urls')),\n\nTemplates\n`````````\n\nCreate a ``base.html`` in the root of your templates directory. Extend ``dcbase/base.html`` and override\nblocks that are global to your site. For example::\n\n {% extends \"dcbase/base.html\" %}\n \n {% block headerBarBrand %}My Site Brand{% endblock %}\n {% block footerBar %}\n Footer content!\n {% endblock %}\n\nTemplates\n---------\n\nDC-Base provides templates to override and include.\n\nBase\n````\n\nThe ``dcbase/base.html`` provides the basic page framework and layout. Provide your site's base template by extending this template\nand overriding the following blocks.\n\n- **pageTitle**: title of the page, as it will appear in the browser window's title bar\n- **style**: inline CSS to include in the page style tag. you need to include your own enclosing \\