Skip to main content

REST Framework for pyramids

Project description

=============
Lovely PyRest
=============

Lovely Pyrest is an extension for
`Pyramid <http://www.pylonsproject.org/projects/pyramid/about>`_ to easily create
REST-Services. It provides functionallity to define service endpoints with the
following features:

Features
========

- Sphinx extension to automatically generate documentation
- It's possible to get help information of every endpoint
- Schema-validation based on `jsonschema <http://json-schema.org/>`_
- returns correct error codes if request method is not supportet or `Accept`-
or `Content-Type`-Headers don't match

Documentation
=============

Take a look at the `documentation <http://lovelysystems.github.io/lovely.pyrest/>`_
for usage information.

Installation
============

Installing via pip
------------------

To install lovely.pyrest via `pip <https://pypi.python.org/pypi/pip>`_ use
the following command::

$ pip install lovely.pyrest

To update use::

$ pip install -U lovely.pyrest

Installing via easy_install
---------------------------

If you prefer easy_install which is provided by
`setuptools <https://pypi.python.org/pypi/setuptools/1.1>`_
use the following command::

$ easy_install lovely.pyrest

To update use::

$ easy_install -U lovely.pyrest


Development Setup
=================

For development setup instructions see:

DEVELOPER.rst


========================
Changes for Lovey Pyrest
========================

unreleased
==========

2013/11/13 0.1.5
================

- added 'accept_catch_all' view functionality.

2013/11/12 0.1.4
================

- New JSONP error handling. If an error occurs while processing a JSONP
request, the HTTP response will always be '200 OK'. The error message
can be processed in the JSONP callback.

- introduced new 'settings' module

2013/11/11 0.1.3
================

- added `services` option to sphinx directive to avoid duplicate rendering
of service docs

2013/10/21 0.1.2
================

- fixed wrong hyperlinks in documentation

2013/10/21 0.1.1
================

- removed development info from README and rephrased the introduction

2013/10/21 0.1.0
================

- added information how to publish documentation on gh-pages

- auto-doc: fixed bug where normal text gets included in <h4> tag

- removed closed source dependencies, so this package can be open sourced

- added license information

2013/10/11 0.0.11
=================

- bugfix: fixed query validation

2013/10/11 0.0.10
=================

- convert boolean for query parameter validation

2013/10/11 0.0.9
================

- changed schema validation for compatibility

2013/10/11 0.0.8
================

- number conversation for query parameters

2013/10/09 0.0.7
================

- Services provide help functionality by default

2013/10/08 0.0.6
================

- enabled JSONP support

2013/10/08 0.0.5
================

- added sphinx extension to generate service documentation automatically

2013/10/04 0.0.4
================

- possibility to use array type in GET query validation

2013/10/02 0.0.3
================

- added documentation

2013/10/01 0.0.2
================

- include DEFAULT_FORMAT_VALIDATORS from validictory

2013/10/01 0.0.1
================

- added basic functionallity:
* raise a 405 if an unimplemented method is called on a service
* provide schema validation
* raise correct errors if the `Accept` or `Content-Type` headers mismatch

- initial commit

Project details


Download files

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

Files for lovely.pyrest, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size lovely.pyrest-0.1.5.tar.gz (20.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page