Skip to main content

Some toolkits for RESTful API development in Pyramid.

Project description

=========================
pyramid_restful_toolkit
=========================


A toolkit for RESTful API development in Pyramid.

That includes:

1. JSON renderer
2. HTTP Auth Policy (Basic, Digest)
3. Some utilities to work with SQLAlchemy, CQLEngine

-----
API
-----

To use it, just

.. code-block::python

config.include('pyramid_restful_toolkit')

This will do those jobs:

1. Add JSON as default renderer with some default adapters. You can access
it through `pyramid_restful_toolkit.default_renderer`
2. Add some error handlers for common validators library such as: formencode,
colander, schema.

If you want all uncaught exception has return as JSON text. Just include tween
`pyramid_restful_toolkit.jsonize_uncaught_exception_tween_factory`. This is
normally used in production.ini.


HTTP Auth Policy
################

To use this package, in the app function, just include it.

config.include("pyramid_restful_toolkit.auth")

In you *development.ini*

pyramid_restful_toolkit.auth.get_user_callback = 'path to get user function'

You can use built-in model:

**For SQLAlchemy**

config.include("pyramid_restful_toolkit.auth.models.sqlalchemy")

with *development.ini*

pyramid_restful_toolkit.auth.dbsession = app.models.DBSession

Use *pyramid_restful_toolkit.auth.models.sqlalchemy.RESTfulUser* to manage your users. Its table
name is *rest_user*.


-----------
CHANGES LOG
-----------

1.0.2
=====

* Add default error handler support for deform.ValidationFailure

Project details


Release history Release notifications

History Node

1.1.1

History Node

1.1.0

History Node

1.0.3.1

History Node

1.0.3

This version
History Node

1.0.2

History Node

1.0.1

History Node

1.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
pyramid_restful_toolkit-1.0.2.tar.gz (23.4 kB) Copy SHA256 hash SHA256 Source None Jul 1, 2014

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