Add documentation about the platforms and databases supported by Oscar.

Also remove unused migrations test for MySQL.

docs/source/index.rst

@@ -98,6 +98,7 @@ All you need to start developing an Oscar project.
 .. toctree::
    :maxdepth: 1
 
+   ref/platform_database_support
    topics/customisation
    topics/class_loading_explained
    topics/prices_and_availability
@@ -129,4 +130,3 @@ Learn about the ideas behind Oscar and how you can contribute.
    internals/design-decisions
    releases/index
    internals/contributing/index
-

docs/source/internals/contributing/bugs-and-features.rst

@@ -5,9 +5,6 @@ Reporting bugs and requesting features
 Before reporting a bug or requesting a new feature, please consider these
 general points:
 
-* Be aware that Windows and the Django admin interface are unsupported; any
-  tickets regarding that will get closed.
-
 * Check that someone hasn't already filed the bug or feature request by
   searching in the ticket tracker.
 

docs/source/internals/contributing/development-environment.rst

@@ -73,10 +73,10 @@ For this to work, you will need to ensure that the pre-processor binary
 
 .. _npm: https://www.npmjs.com/
 
-Testing migrations against MySQL and PostgreSQL
------------------------------------------------
+Testing migrations
+------------------
 
-To test the migrations against MySQL and PostgreSQL you will need to set
+To test the migrations against PostgreSQL you will need to set
 up an environment with both installed and do the following:
 
 1. Change to sandbox folder and activate your virtualenv
@@ -85,5 +85,4 @@ up an environment with both installed and do the following:
 
     ./test_migrations.sh
 
-This will recreate the Oscar database in both MySQL and PostgreSQL and rebuild
-it using ``migrate``.
+This will recreate the Oscar database in PostgreSQL and rebuild it using ``migrate``.

docs/source/internals/sandbox.rst

@@ -49,12 +49,6 @@ Run the sandbox locally
 It's pretty straightforward to get the sandbox site running locally so you can
 play around with Oscar.
 
-.. warning::
-
-    While installing Oscar is straightforward, some of Oscar's dependencies
-    don't support Windows and are tricky to be properly installed, and therefore
-    you might encounter some errors that prevent a successful installation.
-
 In order to compile uWSGI, which is a dependency of the sandbox, you will
 first need to install the Python development headers with:::
 

docs/source/ref/platform_database_support.rst

@@ -0,0 +1,28 @@
+=============================
+Platform and database support
+=============================
+
+Operating system
+================
+
+Oscar does not support for Microsoft Windows. Some of Oscar's dependencies don't support Windows and/or are
+tricky to install properly in that environment, and therefore you might encounter some errors that prevent a
+successful installation. Contributions to improve support for Windows are welcome.
+
+
+Databases
+=========
+
+Oscar officially supports PostgreSQL. Oscar is likely to work with the following databases, but official support is
+not provided for them:
+
+* MariaDB
+* Oracle
+* SQLite (this is suitable only for use in development)
+
+Oscar does not support MySQL. Developers are likely to encounter issues related to Unicode handling and update queries
+for certain query types. Both issues are caused by limitations in MySQL itself, or in Django's ORM support for MySQL.
+Relevant discussions on Django project are:
+
+* `Make MySQL backend default to utf8mb4 encoding <https://code.djangoproject.com/ticket/18392>`_.
+* `QuerySet.update() fails on MySQL if a subquery references the base table <https://code.djangoproject.com/ticket/28787>`_.

requirements_migrations.txt

@@ -1,3 +1,2 @@
 # Those dependencies are needed for the test_migrations.sh script
-PyMySQL==0.9.3
-psycopg2==2.8.5
+psycopg2-binary

sandbox/settings.py

@@ -38,8 +38,6 @@ CACHES = {
 # 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.
 USE_TZ = True
 TIME_ZONE = 'Europe/London'
 

sandbox/settings_mysql.py

@@ -1,15 +0,0 @@
-import pymysql
-pymysql.install_as_MySQLdb()
-
-from settings import *  # noqa
-
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.mysql',
-        'NAME': 'oscar_travis',
-        'USER': 'travis',
-        'PASSWORD': '',
-        'HOST': 'localhost',
-        'PORT': '',
-    }
-}

sandbox/test_migrations.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-# 
-# Test migrations run correctly with MySQL and Postgres
+#
+# Test migrations run correctly
 
 # Fail if any command fails
 # http://stackoverflow.com/questions/90418/exit-shell-script-based-on-process-exit-code
@@ -9,22 +9,14 @@ set -o pipefail
 
 if [ ! "$TRAVIS" == "true" ]
 then
-  # If not on Travis, then create databases
-  echo "Creating MySQL database and user"
-  mysql -u root -e "DROP DATABASE IF EXISTS oscar_travis; CREATE DATABASE oscar_travis"
-  mysql -u root -e "GRANT ALL PRIVILEGES ON oscar_travis.* TO 'travis'@'localhost' IDENTIFIED BY '';"
-
-  echo "Creating Postgres database and user"
+  # If not on Travis, then create database
+  echo "Creating PostgreSQL database and user"
   psql -c "DROP ROLE IF EXISTS travis"
   psql -c "CREATE ROLE travis LOGIN PASSWORD ''"
   psql -c "DROP DATABASE IF EXISTS oscar_travis"
   psql -c "CREATE DATABASE oscar_travis"
 fi
 
-# MySQL
-echo "Running migrations against MySQL"
-./manage.py migrate --noinput --settings=settings_mysql
-
 # Postgres
 echo "Running migrations against Postgres"
 ./manage.py migrate --noinput --settings=settings_postgres