Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

UNKNOWN

Project description

# Duck Admin
A Django reusable app for show and operate custom forms in admin.

## Purpose

The Django Admin is great!
But it is highly depends on it's orm.

Data source not supported by Django's orm (e.g, redis, mongodb) can not show
in Django's admin site.

This app help you make your data (in redis, mongodb, file...) show in Django's Admin site.
Even you can operate with your data. (Add, Modify, Delete)


## Install

```
pip install duckadmin
```

## Usage

1. add `'duckadmin'` in `INSTALLED_APPS`
2. define your form. (you can place it in `forms.py`, `models.py`, anywhere you like)

Demonstration ( more details see [example](/example/redisapp/forms.py) )
```python
from duckadmin import DuckForm

# We define form (not model)
class MyRedisForm(DuckForm):
app_label = 'redisapp' # your app name
model_name = 'Person' # link url
verbose_name = 'Person' # name displayed in admin site
pk_name = 'id'

GENDER = (
(1, 'male'),
(2, 'female'),
)

# fields defined below will show in admin site
id = forms.IntegerField()
name = forms.CharField(max_length=32)
gender = forms.ChoiceField(choices=GENDER)
age = forms.IntegerField()

# you should implement the api below:
# `request` is django request instance

@classmethod
def get_count(cls, request):
# get count of datasets
# return integer

@classmethod
def get_data(cls, request, start, stop):
# get all data to display in change list page
# return list of data.
# data is dict format, key is fields defined above

@classmethod
def get_data_by_pk(cls, request, pk):
# change form view

@classmethod
def create_data(cls, request, data):
# create new data

@classmethod
def update_data(cls, request, data):
# update an exist data
```

3. define admin. (in file `admin.py`)

```python
from django.contrib import admin
from duckadmin import DuckAdmin
from redisapp.forms import MyRedisForm

@admin.register(MyRedisForm)
class MyRedisAdmin(DuckAdmin):
duck_form = MyRedisForm

```

After this settings. you will see `Person` in admin site.

![admin](/images/admin.png)

And the change list page

![change_list](/images/change_list.png)

You can add, modify record

![change_form](/images/change_form.png)


Project details


Release history Release notifications

This version
History Node

0.2.0

History Node

0.1.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
duckadmin-0.2.0.tar.gz (8.1 kB) Copy SHA256 hash SHA256 Source None Aug 1, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page