django-admin-backend 0.2.0.dev4

A replacement of django.contrib.admin

==============
django-backend
==============

|pypi-badge| |build-status|

.. note::

This module can be imported in python with the name ``django_backend``. The
PyPI package is called `django-admin-backend`_ though. We had to use a
different name as ``django-backend`` was already registered on PyPI. It's a
little unfortunate this way, but a necessary workaround for now.

.. _django-admin-backend: https://pypi.python.org/pypi/django-admin-backend

Installation
============

Add the following apps to your ``INSTALLED_APPS`` settings:

.. code-block:: python

INSTALLED_APPS = (
...
'django.contrib.auth',
'django.contrib.sites',
'django.contrib.staticfiles',
...
'django_backend',
'floppyforms',
)

Make sure ``SITE_ID`` is set:

.. code-block:: python

SITE_ID = 1

Make sure ``LANGUAGE_CODE`` is valid:

.. code-block:: python

LANGUAGE_CODE = 'en'

**Warning:** Django's default language code is *not* valid, as "en-us" is not included in settings.LANGUAGES.

Add the following line to your ``urls.py``:

.. code-block:: python

url(r'^backend/', include(django_backend.site.get_urls(), namespace='django_backend')),

TODO: continue, propably not complete yet

Development
===========

Run tests
---------

.. code-block:: bash

# Set everything up. You want to do this in a virtualenv.
pip install -r tests/requirements.txt
python setup.py develop

# Run the tests. Should be executed in the root of the project.
py.test

.. |build-status| image:: https://travis-ci.org/team23/django_backend.svg
:target: https://travis-ci.org/team23/django_backend

.. |pypi-badge| image:: https://img.shields.io/pypi/v/django-admin-backend.svg
:target: https://pypi.python.org/pypi/django-admin-backend

Build static assets
-------------------

.. code-block:: bash

npm install
gulp build

# Use gulp watch to continuously build on source file changes.
gulp watch

Or to create a development build that includes source maps, execute the ``dev`` task first, like:

.. code-block:: bash

gulp dev build


0.2.0 (not released yet)
------------------------

* Adjusted multiple imports:

- Forms, formfields and widgets should be now always imported from
``django_backend.forms``. Example::

# OLD import, will no longer work
from django_backend.backend.base.formfields import SelectRelatedField

# NEW import
from django_backend.forms import SelectRelatedField

* Add ``ManageRelatedField`` that can inline a list page of a related model
in the change view.

* Add ``GenericRelationListField`` that can show a reorderable list related
by a intermediary model with a generic foreign key.

0.1.0
-----

* Initial release.