# MicroService framework :: Resource¶

## What is this package for¶

In the python world there are many RESTFul framework. Some of them based on Django others are based on Flask. I’ve tried some but I had the feeling, I want to learn one, the use with Django or Flask or even Odoo. And I don’t mention sometimes I found them not flexible enough. So, I’ve decided write my own independent framework what anybody can use in at least the mentioned 3 different worlds.

## Nutshell (notice that, it would be the achivement)¶

from pyrs import resource
from pyrs.resource import GET

class UserResouce:

@GET(response=ArrayOfUserSchema)
def get_users(self):
return User.objects.all()

@PUT(path='/<int:user_id>', response=UserSchema, request=UserSchema)
def update_user(self, user_id, body):
user = get_object_or_404(User, pk=user_id)
user.name = body['name']
user.email = body['email']
user.save()
return user

app = resource.Application()


In this example I’ve shown Django (like) example. The schema is based on pyrs.schema. Even if I tend to use that framework, you would be able to use any other.

## Features¶

• Using simple classes or even functions (no inheritance)
• Wrapped error handling, errors can be serialised
• Extensible API
• Works with python 2.7, 3.3, 3.4 (tested against these versions)
• Hooks for extending the dispatching process

## Installation¶

\$ pip install pyrs-resource


## Dependencies¶

See requirements.txt for details, but mainly depends on Werkzeug. I’m using that project routing capabilities. Also depends on pyrs.schema as I mentioned in nutshell section.

## Important caveats¶

This code right now really in beta state. I plan to release soon as possible a completely working code, but right now it’s just shaping.

## The ecosystem¶

This work is part of pyrs framework. The complete framework follow the same intention to implement flexible solution.

## Contribution¶

I really welcome any comments! I would be happy if you fork my code or create pull requests. I’ve already really strong opinions what I want to achieve and how, though any help would be welcomed.

Feel free drop a message to me!

## Contents:¶

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.