Add a REST interface to simple SQLAlchemy object
Project description
Use it
In <project>/model.py:
from pyramid.security import Allow, Authenticated, ALL_PERMISSIONS
class Object(Base):
__tablename__ = 'object'
__table_args__ = {'autoload':True}
__acl__ = [
(Allow, 'admin', ALL_PERMISSIONS),
(Allow, 'editor', ('view', 'edit', 'new', 'delete')),
(Allow, Authenticated, ('view')),
]
In <project>/views/rest.py:
from pyramid.view import view_config
from c2c.sqlalchemy.rest import REST
from <project>.models import DBSession, Object
obj = REST(DBSession, Object)
@view_config(route_name='obj_read_many', renderer='jsonp')
def obj_read_many(request):
return obj.read_many(request)
@view_config(route_name='obj_read_one', renderer='jsonp')
def obj_read_one(request):
return obj.read_one(request)
@view_config(route_name='obj_count', renderer='string')
def obj_count(request):
return obj.count(request)
@view_config(route_name='obj_create', renderer='jsonp')
def obj_create(request):
return obj.create(request)
@view_config(route_name='obj_update')
def obj_update(request):
return obj.update(request)
@view_config(route_name='obj_delete', renderer='jsonp')
def obj_delete(request):
return obj.delete(request)
In <project>/__init__.py:
from pyramid.renderers import JSONP
from c2c.sqlalchemy.rest import add_rest_routes
config.add_renderer('jsonp', JSONP(param_name='callback'))
add_rest_routes(config, 'obj', '/object')
From source
Build:
python bootstrap.py --distribute -v 1.7.1 ./buildout/bin/buildout
Protocol
Read many, GET on .../obj:
{
"objects": [{
"id": id,
"property": "value",
...
},
...
]
}
Read one, GET on .../obj/{id}:
{
"id": id,
"property": "value",
...
}
Count, GET on .../obj/count:
23
Create, POST on .../obj with data:
{
"property": "value",
...
}
and it will return the id.
Update, PUT on .../obj/{id} with data:
{
"property": "value",
...
}
Delete, DELETE on .../obj/{id}.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file c2c.sqlalchemy.rest-0.2.tar.gz
.
File metadata
- Download URL: c2c.sqlalchemy.rest-0.2.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4de223aa3aa1bb04a91defd21aacbeca75a6c8146895668a402392fbfbfcc6e3 |
|
MD5 | e6ca13a2d5da295ed42f6a511f00c997 |
|
BLAKE2b-256 | e260f517cd70845d90181bc9ca8c77d55e6ebe20c0a4952fd1abc64004a56068 |