pyrs 0.4

Python microservice framework

Project homepage: https://github.com/palankai/pyrs

Documentation: http://pyrs.readthedocs.org/

Issues: https://github.com/palankai/pyrs/issues

What is this package for

This package basically an umbrella for other packages. Ensure basic helpers for them like configuration, context, decorators, etc.

The ecosystem

Schema validation, serialization

With this module you can define schemas then you can validate and serialize your data.

Project homepage: https://github.com/palankai/pyrs-schema

Documentation: http://pyrs-schema.readthedocs.org/

Restful web framework

This module ensure a routing and dispatching through defined resources. Baased on schema you can define interface which would be validate. It’s an independent solution could work with Flask, Django or even Odoo.

Project homepage: https://github.com/palankai/pyrs-resource

Documentation: http://pyrs-resource.readthedocs.org/

Swagger builder

If you know Swagger then you know in python world there is not that easy to use that. You have to make your documentation by hand. This package aim to make it much more easier.

Project homepage: https://github.com/palankai/pyrs-swagger

Documentation: http://pyrs-swagger.readthedocs.org/

Installation

$ pip install pyrs

Note

You have to install the other packages independently.

Extending the exist functionality

The pyrs.ext and the pyrs itself are namespace packages. If you would like to extend an exist functionality of a package check that given package documentation for further information.

If you would like to implement a new funcionality, just create a new package inside pyrs package. Make sure the pyrs package still remain namespace package.

Dependencies

See requirements.txt. But The goal is less dependency as possible. Aim to work with python 2.7, 3.3, 3.4+ (tested agains them).

Important caveats

This code is in beta version. I working hard on write stable as possible API in the first place but while this code in 0.x version you should expect some major modification on the API.

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!