Go to file
Andy Baker 7f6567af39 Mislabelled 1.8 > 1.7 in tox.ini. Remove South dep 2015-07-04 10:53:12 +01:00
admin_tools Add Ukrainian locale 2015-07-03 11:53:42 +03:00
docs dashboard.rst edited online with Bitbucket , fixed manage.py , was manage , added 2014-08-14 14:00:33 +00:00
test_proj Merged in hirokiky/django-admin-tools/supportdj16 (pull request #27) and also added python3.3/django1.6 environment 2013-12-27 11:45:43 +01:00
.hgignore Ignore tox and virtualenv dirs 2013-02-25 15:51:38 +01:00
.hgtags Added tag 0.5.2 for changeset 746357689a8d 2014-08-11 18:07:00 +02:00
.travis.yml add travis config 2015-06-20 12:35:20 +01:00
AUTHORS increased depth of the TOC, added some aknowledgements, removed a todo item 2010-02-07 15:16:44 +01:00
CHANGELOG Release 0.5.2 2014-08-11 18:06:34 +02:00
INSTALL prepare for release 0.1.0 2010-02-09 02:21:50 +01:00
LICENSE initial import 2010-02-04 14:15:56 +01:00
MANIFEST.in fix setup and manifest for new readme filename 2015-06-20 13:07:55 +01:00
README.rst New readme 2015-06-20 13:06:54 +01:00
runtests.sh Include admin_tools root package in test coverage 2010-04-26 09:56:51 +06:00
setup.py fix setup and manifest for new readme filename 2015-06-20 13:07:55 +01:00
tox.ini Mislabelled 1.8 > 1.7 in tox.ini. Remove South dep 2015-07-04 10:53:12 +01:00

README.rst

django-admin-tools
==================

.. image:: https://travis-ci.org/django-admin-tools/django-admin-tools.svg?branch=master
    :target: https://travis-ci.org/django-admin-tools/django-admin-tools


django-admin-tools is a collection of extensions/tools for the default django 
administration interface, it includes:

* a full featured and customizable dashboard;
* a customizable menu bar;
* tools to make admin theming easier.

The code is hosted on `Github <https://github.com/django-admin-tools/django-admin-tools/>`_. 

Django-admin-tools is generously documented, you can 
`browse the documentation online 
<http://django-admin-tools.readthedocs.org/>`_.
a good start is to read `the quickstart guide 
<http://django-admin-tools.readthedocs.org/quickstart.html>`_.

The project was created by `David Jean Louis <http://www.izimobil.org/>`_ and was previously hosted on `Bitbucket <http://bitbucket.org/izi/django-admin-tools/>`_. 

Please join the `mailing list <http://groups.google.fr/group/django-admin-tools>`_ if you want to discuss of the future of django-admin-tools.

************
Installation
************

To install django-admin-tools, run the following command inside this directory:

    python setup.py install

If you have the Python **easy_install** utility available, you can also type 
the following to download and install in one step::

    easy_install django-admin-tools

Or if you're using **pip**::

    pip install django-admin-tools

Or if you'd prefer you can simply place the included "admin_tools" directory 
somewhere on your python path, or symlink to it from somewhere on your Python 
path; this is useful if you're working from a Mercurial checkout.

An `installation guide <http://django-admin-tools.readthedocs.org/en/latest/installation.html>`_ is available in the documentation.

*************
Documentation
*************

`Extensive documentation <http://django-admin-tools.readthedocs.org/>`_ is available, it was made with the excellent `Sphinx program <http://sphinx.pocoo.org/>`_

************
Translations
************

There is a `a transifex project <https://transifex.net/projects/p/django-admin-tools/>`_ for django-admin-tools.

************
Screenshots
************

The django admin login screen:

.. image:: http://www.izimobil.org/django-admin-tools/images/capture-1.png
   :alt: The django admin login screen


The admin index dashboard:

.. image:: http://www.izimobil.org/django-admin-tools/images/capture-2.png
   :alt: The admin index dashboard


The admin menu:

.. image:: http://www.izimobil.org/django-admin-tools/images/capture-3.png
   :alt: The admin menu

Dashboard modules can be dragged, collapsed, closed etc.:

.. image:: http://www.izimobil.org/django-admin-tools/images/capture-4.png
   :alt: Dashboard modules can be dragged, collapsed, closed etc. 

The app index dashboard:

.. image:: http://www.izimobil.org/django-admin-tools/images/capture-5.png
   :alt: The app index dashboard