django-dynamic-views 0.1.1

=============================
django-dynamic-views
=============================

.. image:: https://badge.fury.io/py/django-dynamic-views.png
:target: https://badge.fury.io/py/django-dynamic-views

.. image:: https://travis-ci.org/ddaan/django-dynamic-views.png?branch=master
:target: https://travis-ci.org/ddaan/django-dynamic-views

Provides out of the box CRUD functionality including templates and gives you the ability to build your screen top-down.

Documentation
-------------

The full documentation is at https://django-dynamic-views.readthedocs.org.

Quickstart
----------

Install django-dynamic-views::

pip install django-dynamic-views

Then use it in a project::

from django_dynamic_views.views import DynamicListView, DynamicCRUDView, DynamicUpdateView, DynamicCreateView



Add django-dynamic-views to installed apps::

INSTALLED_APPS = (
...
'django_dynamic_views',
...
)



Example
=====================

Consider this simple model:

models.py

::

class Article(models.Model):
name = models.Charfield(max_length=200)
description = models.Charfield(max_length=200)

Define a Crud view by extending DynamicCRUDView and set the model as a attribute

views.py
::

class ArticleCRUDView(DynamicCRUDView):
model = Article

Now add the urls to your urlpatterns with one command

urls.py
::

urlpatterns += ArticleCRUDView.urls()

You'll point your browser to /article/list/ and a basic list with Create / Read / Update and Delete
buttons will be displayed.

So on the background it will create the following urls::

/article/list/
/article/create/
/article/(?P<pk>[-\w]+)/update/
/article/(?P<pk>[-\w]+)/read/
/article/(?P<pk>[-\w]+)/delete/

If you don't care for some of the urls you can modfiy the _links_ atribute on the CrudView::

class ArticleCRUDView(dynamicviews.DynamicCRUDView):
model = Article
links = ['list', 'read']

This will result in the following urls::

/article/list/
/article/(?P<pk>[-\w]+)/read/

So this will give you a basic list with a Read button next to it.

## Override the default classes
You can define which class the CRUD uses, so you can easily modify it's appearance and behaviour

::

class ArticleDetailView(DetailView):
template_name = 'articles/article_detail.html'


class ArticleCRUDView(dynamicviews.DynamicCRUDView):
model = Article
links = ['list', 'read']
read_class = ArticleDetail



Running Tests
--------------

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

Credits
---------

Tools used in rendering this package:

* Cookiecutter_
* cookiecutter-pypackage_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _cookiecutter-djangopackage: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.1.0 (2016-04-09)
++++++++++++++++++

* First release on PyPI.