Skip to main content

REST Framework for pyramids

Project description

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

Lovely Pyrest provides helpers to build REST-Webservices with pyramid.

Features
========

- raise a 405 if an unimplemented method is called on a servie
- provides schema validation using validictory
- raises correct errors if the `Accept` or `Content-Type` header doesn't match
- sphinx extension to automatically generate service documentation

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

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

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

For development setup instructions see:

INSTALL.txt

Bootstrap and buildout
======================

Bootstrap with python 2.7::

/opt/local/bin/python2.7 bootstrap.py

Run buildout::

./bin/buildout -N

Note::

Python shouldn't have installed any 3rd party packages

Testing
=======

To run all the tests use::

./bin/test

For additional testrunner options run::

./bin/test --help

Generating Documentation
========================

Before generating the new documentation make sure the `gh-pages` submodule is up-to-date::

git submodule init

git submodule update

To generate the new documentation run::

./bin/sphinx-html

The documentation is located in the `gh-pages` directory which points to the
`gh-pages` submodule.

Publish documentation
---------------------

To publish the documentation commit the changed files in the `gh-pages`
submodule::

cd gh-pages

git add <changed-files>

git commit -m "updated documentation"

git push origin gh-pages


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

unreleased
==========

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.0
Filename, size File type Python version Upload date Hashes
Filename, size lovely.pyrest-0.1.0.tar.gz (17.6 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