This release is a pre-release and may not be stable for production use.
c2c.sqlalchemy.rest
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')
Using Relationships
It is possible to retrieve related objects with read_many and read_one actions provided that the relationships are defined in the models and that they are passed to the REST constructor. For instance:
class Tag(GeoInterface, Base):
__tablename__ = 'tag'
__table_args__ = (
UniqueConstraint('name'),
{"schema": 'tagging'}
)
__acl__ = [
(Allow, 'admin', ALL_PERMISSIONS),
(Allow, 'editor', ('view', 'edit', 'new', 'delete')),
(Allow, Everyone, ('view')),
]
id = Column(types.Integer, primary_key=True)
name = Column(types.Unicode(200), nullable=False)
active = Column(types.Boolean, default=True)
l10n = relationship("TagL10n", backref="tag")
childrenTags = relationship("Tag",
secondary=tag_tag,
primaryjoin=id==tag_tag.c.tag_id1,
secondaryjoin=id==tag_tag.c.tag_id2,
order_by=name, backref="parentTags")
tag_children = {
'childrenTags': { 'rest': REST(DBSession, Tag) }
}
tag = REST(DBSession, Tag, children=tag_children)
The name of the property containing the related objects may be specified using the propname parameter (default is the relationship name):
tag_children = {
'childrenTags': { 'rest': REST(DBSession, Tag), 'propname': 'tags' }
}
tag = REST(DBSession, Tag, children=tag_children)
Example result:
{
"active": false,
"tags": [{
"active": true,
"name": "Artenschutz",
"id": 31
}, {
"active": false,
"name": "Pioniervegetation",
"id": 71
}],
"name": "Naturschutz",
"id": 58
}
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}.
Metadata
Release files for c2c.sqlalchemy.rest 0.3dev-20131025
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| c2c.sqlalchemy.rest-0.3dev-20131025.tar.gz | 5.0 kB | Without provenance | Details for c2c.sqlalchemy.rest-0.3dev-20131025.tar.gz |
Release files / c2c.sqlalchemy.rest-0.3dev-20131025.tar.gz
| Download URL | c2c.sqlalchemy.rest-0.3dev-20131025.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71d54a3f48de82c9a4a03c7bb194d03c4aca49f59424bbec28b3daa29b86e476
|
|
BLAKE2b-256 checksum How to use checksums |
cbb6284002045f520d6ed09064b6824e508a8d7ffd3ea63310cc5ebac329c3f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for c2c.sqlalchemy.rest 0.3dev-20131025
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.