diff --git a/INSTALL b/INSTALL index c554519..5e0d7eb 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,7 @@ Thanks for downloading django-admin-tools. -This application requires Python 2.4 or later and Django 1.1.0 or newer. +This application requires Python 2.7 or later and Django 1.7 or newer. +django-admin-tools is fully compatible with Python 3. It is also recommended that you install the FeedParser module (http://www.feedparser.org/) if you want to use the feed dashboard module. diff --git a/docs/configuration.rst b/docs/configuration.rst index e9938a6..ad94625 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -33,6 +33,12 @@ Required settings First make sure you have the ``django.core.context_processors.request`` template context processor in your ``TEMPLATE_CONTEXT_PROCESSORS``. +.. note:: + Starting from django 1.8, ``TEMPLATE_CONTEXT_PROCESSORS`` is deprecated, + you must add the request context processor in your ``TEMPLATES`` variable + instead, please refer to the + `relevant django documentation `_. + Then, add the django-admin-tools modules to the ``INSTALLED_APPS`` like this:: @@ -69,13 +75,7 @@ Setting up the database To set up the tables that django-admin-tools uses you'll need to type:: - python manage.py syncdb - -django-admin-tools supports `South `_, so if you -have South installed, make sure you run the following commands:: - - python manage.py migrate admin_tools.dashboard - python manage.py migrate admin_tools.menu + python manage.py migrate Adding django-admin-tools to your urls.py file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/contributing.rst b/docs/contributing.rst index 239e5e3..20bcdd1 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -4,19 +4,17 @@ Contributing to django-admin-tools ================================== You are very welcome to contribute to the project! django-admin-tools is -hosted at `Bitbucket `_, +on `Github `_, which makes collaborating very easy. There are various possibilities to get involved, for example you can: -* `Report bugs `_, +* `Report bugs `_, preferably with patches if you can * `Discuss new features ideas `_ -* `fork the project `_, - implement those features and send a pull request -* Enhance the `documentation - `_ +* Fork the project, implement those features and send a pull request +* Enhance the `documentation `_ * `Translate django-admin-tools `_ in your language diff --git a/docs/installation.rst b/docs/installation.rst index 92c8bb8..f65a39e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -8,7 +8,13 @@ Requirements Before installing django-admin-tools, you'll need to have a copy of `Django `_ already installed. For the -|version| release, Django 1.3 or newer is required. +|version| release, Django 1.7 or newer is required. + +.. note:: + *Important note to users of django 1.6 or below:* + starting from 0.6.0, django-admin-tools is *NOT* compatible with + django <= 1.6. If you want, you can still use the 0.5.2 version + that will always be available on Pypi. For further information, consult the `Django download page `_, which offers convenient @@ -95,19 +101,17 @@ installation script. From a command line in that directory, type:: privileges (e.g., ``sudo python setup.py install``). -Manual installation from a Mercurial checkout -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Manual installation from a git checkout +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you'd like to try out the latest in-development code, you can -obtain it from the django-admin-tools repository, which is hosted at -`Bitbucket `_ and uses `Mercurial -`_ for version control. To -obtain the latest code and documentation, you'll need to have -Mercurial installed, at which point you can type:: +obtain it from the django-admin-tools repository, which is hosted on +`Github `_. +To obtain the latest code and documentation, you'll need to have +Git installed, at which point you can type:: - hg clone http://bitbucket.org/izi/django-admin-tools/ + git clone https://github.com/django-admin-tools/django-admin-tools.git -This will create a copy of the django-admin-tools Mercurial repository -on your computer; you can then add the ``django-admin-tools`` directory -to your Python import path, or use the ``setup.py`` script to install -as a package. +This will create a copy of the django-admin-tools Git repository on your +computer; you can then add the ``django-admin-tools`` directory to your +Python import path, or use the ``setup.py`` script to install as a package. diff --git a/docs/multiple_admin_sites.rst b/docs/multiple_admin_sites.rst index 9154e48..f13b504 100644 --- a/docs/multiple_admin_sites.rst +++ b/docs/multiple_admin_sites.rst @@ -8,17 +8,10 @@ Introduction Django supports custom admin sites, and of course you can have as many admin sites as you want, django-admin-tools provides basic support for -this, you can setup a custom dashboard for each admin site. +this, you can setup a custom dashboard or menu for each admin site. -.. note:: - Multiple admin site support in django-admin-tools is, at the moment, - limited to dashboards. This means you cannot have different menus or - theming for each instance of admin sites. This will change in the near - near future though. - - -Setting up a different dashboard for each admin site instance -------------------------------------------------------------- +Setting up a different dashboard and menu for each admin site instance +---------------------------------------------------------------------- In the following example we will assume that you have two admin site instances: the default django admin site and a custom admin site of your @@ -51,3 +44,16 @@ settings file:: Note that the same applies for the ``ADMIN_TOOLS_APP_INDEX_DASHBOARD`` settings variable. + +Finally do the same thing for menu:: + + python manage.py custommenu django_admin_menu.py + python manage.py custommenu my_admin_menu.py + +And to tell django-admin-tools to use your custom menu depending on +the admin site being used:: + + ADMIN_TOOLS_MENU = { + 'django.contrib.admin.site': 'yourproject.django_admin_menu.CustomMenu', + 'yourproject.admin.admin_site': 'yourproject.my_admin_menu.CustomMenu', + } diff --git a/docs/quickstart.rst b/docs/quickstart.rst index d08e27e..45fe5a7 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -5,7 +5,13 @@ Quick start guide Before installing django-admin-tools, you'll need to have a copy of `Django `_ already installed. For the -|version| release, Django 1.3 or newer is required. +|version| release, Django 1.7 or newer is required. + +.. note:: + *Important note to users of django 1.6 or below:* + starting from 0.6.0, django-admin-tools is *NOT* compatible with + django <= 1.6. If you want, you can still use the 0.5.2 version + that will always be available on Pypi. Installing django-admin-tools @@ -54,6 +60,12 @@ Configuration First make sure you have the ``django.core.context_processors.request`` template context processor in your ``TEMPLATE_CONTEXT_PROCESSORS``. +.. note:: + Starting from django 1.8, ``TEMPLATE_CONTEXT_PROCESSORS`` is deprecated, + you must add the request context processor in your ``TEMPLATES`` variable + instead, please refer to the + `relevant django documentation `_. + Then, add admin_tools and its modules to the ``INSTALLED_APPS`` like this:: INSTALLED_APPS = ( @@ -82,12 +94,7 @@ Then, just add django-admin-tools to your urls.py file:: Finally simply run:: - python manage.py syncdb - -If you have South installed, make sure you run the following commands:: - - python manage.py migrate admin_tools.dashboard - python manage.py migrate admin_tools.menu + python manage.py migrate Testing your new shiny admin interface -------------------------------------- @@ -99,4 +106,3 @@ changed. django-admin-tools is fully customizable, but this is out of the scope of this quickstart. To learn how to customize django-admin-tools modules please read :ref:`the customization section`. - diff --git a/docs/testing.rst b/docs/testing.rst index 7e65200..f1379e3 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -7,28 +7,14 @@ This is information for developers of django-admin-tools itself. Running tests ------------- -Run the `runtests.sh` script which is situated at the root dir of -django-admin-tools project. -Run all tests:: +First, cd the test_proj directory:: - $ ./runtests.sh + $ cd test_proj -Run only unit tests:: +And to run the tests, just type:: - $ ./runtests.sh unit - -Run only tests for specified app:: - - $ ./runtests.sh dashboard - -Run only one test case:: - - $ ./runtests.sh dashboard.ManagementCommandTest - -Run only one test:: - - $ ./runtests.sh dashboard.ManagementCommandTest.test_customdashboard + $ python manage.py test Code coverage report