Updated documentation to make it gramatically correct

README.rst

@@ -1,15 +1,12 @@
-Django-Oscar - Flexible e-commerce on Django
-============================================
+Django-Oscar - Flexible e-commerce on Django 1.3
+================================================
 
-django-oscar is a flexible ecommerce platform, designed to build domain-driven
-ecommerce sites to be constructed.  It is not supposed to be a framework that can
-be downloaded and fully set up by simply adjusting a configuration file: there
-will always be some developer work required to make sure the models match those
-from your domain - this is the nature of domain modelling.
+django-oscar is a ecommerce framework for Django 1.3 for building domain-driven
+ecommerce sites.  It is structured in way that lets any part of the core
+ecommerce functionality be customised to suit the needs of your project.    
 
-However, a small amount of work up front in determine the right models for your
-shop can really pay off in terms of building a high-quality application that
-is a pleasure to work with and maintain.
+It is currently in vigorous early development, but should stabilise over the
+summer of 2011.
 
-See the ``*.rst`` files within ``docs/source`` for documentation or visit
-http://django-oscar.readthedocs.org/en/latest/
+Browse the ``*.rst`` files within ``docs/source`` for documentation or visit
+http://django-oscar.readthedocs.org/en/latest/ for HTML versions.

docs/source/index.rst

@@ -7,18 +7,36 @@
 Welcome to the documentation for django-oscar
 =============================================
 
-django-oscar is a flexible e-commerce platform for Django, designed to build domain-driven
-ecommerce sites.  It differs from other e-commerce projects in that the core of django-oscar is kept
-quite small but extensible.  Any class within oscar can be subclassed and extended to customise
-the functionality available.  While this means that more work is required up-front to 
-set up the model, form and utility classes, the resulting project should be
-a much better representation of the domain at hand.
+django-oscar is a ecommerce framework for Django 1.3 for building domain-driven
+ecommerce sites.  It is structured in way that lets any part of the core
+ecommerce functionality be customised to suit the needs of your project.    
 
 It is developed by Tangent Labs, a London-based digital agency, and is based on
 their existing Taoshop PHP platform which currently powers several large-scale ecommerce sites.  
 
 It is still in early development, but a stable release is planned for early summer 2011.
-The source is on Github: https://github.com/tangentlabs/django-oscar
+The source is on Github: https://github.com/tangentlabs/django-oscar - all contributions welcome.
+
+Quick start
+===========
+
+We can do this quickly.  Create a virtualenv and install django-oscar::
+
+    mkvirtualenv --no-site-packages vanilla
+    pip install -e git+git://github.com/tangentlabs/django-oscar.git#egg=django-oscar
+
+Take a copy of the example vanilla site, and copy the quickstart settings into place::
+
+    cp -r ~/.virtualenvs/myshop/lib/python2.6/site-packages/src/examples/vanilla/ /tmp/vanilla
+    cd /tmp/vanilla
+    cp settings_quickstart.py settings.py
+
+Import the sample products and images::
+
+    python manage.py import_catalogue ~/.virtualenvs/myshop/src/django-oscar/examples/sample-data/books-catalogue.csv
+    python manage.py import_images ~/.virtualenvs/myshop/src/django-oscar/examples/sample-data/book-images.tar.gz
+
+And there you have it: a fully functional ecommerce site with a product range of 100 popular books.
 
 Getting started:
 

examples/vanilla/settings.py

@@ -1,9 +1,5 @@
-# -*- coding: utf-8 -*-
 import os
 
-LOCALE = 'en_IN.UTF-8'
-CURRENCY_SYMBOL = '₹'
-
 # Django settings for oscar project.
 PROJECT_DIR = os.path.dirname(__file__)
 location = lambda x: os.path.join(os.path.dirname(os.path.realpath(__file__)), x)

examples/vanilla/settings_quickstart.py

@@ -0,0 +1,216 @@
+import os
+
+PROJECT_DIR = os.path.dirname(__file__)
+location = lambda x: os.path.join(os.path.dirname(os.path.realpath(__file__)), x)
+
+DEBUG = True
+TEMPLATE_DEBUG = True
+SQL_DEBUG = True
+
+ADMINS = (
+    # ('Your Name', 'your_email@domain.com'),
+)
+EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+
+MANAGERS = ADMINS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3', 
+        'NAME': '/tmp/oscar_vanilla',     
+        'USER': '',                           
+        'PASSWORD': '',                      
+        'HOST': '',                     
+        'PORT': '',                      
+    }
+}
+
+
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# On Unix systems, a value of None will cause Django to use the same
+# timezone as the operating system.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'Europe/London'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale
+USE_L10N = True
+
+# Absolute path to the directory that holds media.
+# Example: "/home/media/media.lawrence.com/"
+MEDIA_ROOT = location("assets")
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash if there is a path component (optional in other cases).
+# Examples: "http://media.lawrence.com", "http://example.com/media/"
+MEDIA_URL = '/media/'
+
+# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
+# trailing slash.
+# Examples: "http://foo.com/media/", "/media/".
+ADMIN_MEDIA_PREFIX = '/media/admin/'
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '$)a7n&o80u!6y5t-+jrd3)3!%vh&shg$wqpjpxc!ar&p#!)n1a'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.Loader',
+    'django.template.loaders.app_directories.Loader',
+)
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+    "django.contrib.auth.context_processors.auth",
+    "django.core.context_processors.request",
+    "django.core.context_processors.debug",
+    "django.core.context_processors.i18n",
+    "django.core.context_processors.media",
+    "django.core.context_processors.static",
+    "django.contrib.messages.context_processors.messages",
+    # Oscar specific
+    'oscar.apps.search.context_processors.search_form',
+    'oscar.apps.promotions.context_processors.promotions',
+    'oscar.apps.promotions.context_processors.merchandising_blocks',
+) 
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.transaction.TransactionMiddleware',
+    'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
+    # Oscar specific
+    'oscar.apps.basket.middleware.BasketMiddleware'
+)
+
+INTERNAL_IPS = ('127.0.0.1',)
+
+ROOT_URLCONF = 'urls'
+
+TEMPLATE_DIRS = (
+    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'verbose': {
+            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
+        },
+        'simple': {
+            'format': '%(levelname)s %(message)s'
+        },
+    },
+    'handlers': {
+        'null': {
+            'level':'DEBUG',
+            'class':'django.utils.log.NullHandler',
+        },
+        'console':{
+            'level':'DEBUG',
+            'class':'logging.StreamHandler',
+            'formatter': 'verbose'
+        },
+        'file': {
+             'level': 'INFO',
+             'class': 'logging.FileHandler',
+             'filename': '/tmp/oscar.log',
+             'formatter': 'verbose'
+        },
+        'mail_admins': {
+            'level': 'ERROR',
+            'class': 'django.utils.log.AdminEmailHandler',
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers':['null'],
+            'propagate': True,
+            'level':'INFO',
+        },
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': False,
+        },
+        'oscar.checkout': {
+            'handlers': ['console'],
+            'propagate': True,
+            'level':'INFO',
+        },
+        'django.db.backends': {
+            'handlers':['null'],
+            'propagate': False,
+            'level':'DEBUG',
+        },
+    }
+}
+
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.admin',
+    'django.contrib.flatpages',
+    # External dependencies
+    'haystack',
+    'sorl.thumbnail',
+    # Apps from oscar
+    'oscar',
+    'oscar.apps.analytics',
+    'oscar.apps.discount',
+    'oscar.apps.order',
+    'oscar.apps.checkout',
+    'oscar.apps.shipping',
+    'oscar.apps.order_management',
+    'oscar.apps.product',
+    'oscar.apps.basket',
+    'oscar.apps.payment',
+    'oscar.apps.offer',
+    'oscar.apps.address',
+    'oscar.apps.partner',
+    'oscar.apps.image',
+    'oscar.apps.customer',
+    'oscar.apps.promotions',
+    'oscar.apps.reports',
+    'oscar.apps.search',
+    'oscar.apps.product.reviews',
+    'oscar.apps.payment.datacash',
+)
+
+LOGIN_REDIRECT_URL = '/accounts/profile/'
+APPEND_SLASH = True
+
+# Oscar settings
+from oscar.defaults import *
+
+# Haystack settings
+HAYSTACK_SITECONF = 'oscar.search_sites'
+HAYSTACK_SEARCH_ENGINE = 'dummy'