Skip to main content

A hypermedia API framework for Django.

Project description

https://secure.travis-ci.org/zbyte64/django-hyperadmin.png

Introduction

django-hyperadmin is an API framework for building RESTful resources in Django. Resources tend to be anything you can manipulate with forms (including models) and configuration of an API resource is similar to an Admin Model. APIs support REST out of the box and clients may be installed seperately to provide additional functionality.

This is BETA

Documentation: http://django-hyperadmin.readthedocs.org/

Features

  • ModelResource works like AdminModel
  • Data store agnostic
  • Media type agnostic
  • Index classes define search and filter capabilities through forms
  • Autoloads basic functionality from admin site
  • Internal resource representation based on hfactor, forms and endpoints
  • Clients packaged seperately

Supported Media Formats:

  • application/text-html, text/html - provides HTML responses
  • application/json - plain json serialization
  • text/javascript - for jsonp
  • application/vnd.Collection+JSON
  • application/vnd.Collection.next+JSON
  • application/vnd.Collection.hyperadmin+JSON - for the emberjs client
  • TODO: xml, yaml, ???

Headers control media type; “Accepts” and “Content-Type” control response and request format

Requirements

  • Python 2.6 or later
  • Django 1.3 or later

Installation

Install hyperadmin into your python environment:

pip install django-hyperadmin

or:

pip install -e git+git://github.com/zbyte64/django-hyperadmin.git#egg=django-hyperadmin

Put ‘hyperadmin’ into your INSTALLED_APPS section of your settings file.

Add to root url patterns:

url(r'^hyperapi/', include('hyperadmin.urls')),

Clients

Visiting the api endpoint in a browser will let you browse the various hyberobjects made available through the resource. Clients may be installed on a different url.

Django Template Client

https://github.com/zbyte64/django-hyperadmin-client

Uses django templates to render an admin interface. Responsive design out of the box.

Ember REST Client

https://github.com/zbyte64/django-hyperadmin-emberclient

Uses REST calls and emberjs to render an admin interface.

Backbone Bindings

https://github.com/zbyte64/django-hyperadmin-backboneclient

Provides basic bindings to the Backbone API.

Dockit CMS

https://github.com/zbyte64/django-dockitcms (endpoints branch)

A dynamic API builder with a public HTML (template driven) client.

Configuration

ModelResource

Registering models

Registering a model with hyperadmin:

import hyperadmin
from hpyeradmin.resources.models import ModelResource, InlineModelResource
from myapp.models import MyModel, ChildModel

class ChildModelResource(InlineModelResource):
    model = ChildModel

class MyModelResource(ModelResource):
    inlines = [ChildModelResource]
    list_display = ['name', 'number']
    list_filter = ['timestamp', 'category']

hyperadmin.site.register(MyModel, MyModelResource)

Autoloading from Django Admin

The following registers the models from admin site (this is already done if you import from hyperadmin.urls):

from django.contrib import admin
hyperadmin.site.install_models_from_site(admin.site)

API Endpoints

  • “/” lists rows; POST to create
  • “/add/” POST to add
  • “/<id>/” displays a specific row; PUT/POST to update, DELETE to delete
  • “/<id>/delete/” POST to delete

Project details


Release history Release notifications

History Node

0.10.0

History Node

0.9.1

History Node

0.9.0

History Node

0.8.2

This version
History Node

0.8.1

History Node

0.8.0

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
django-hyperadmin-0.8.1.tar.gz (48.6 kB) Copy SHA256 hash SHA256 Source None Jan 18, 2013

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