Lightweight framework for building resource-oriented applications.
Project description
Roax
Ro·ax /ˈɹoʊ.æks/
A lightweight Python resource-oriented framework.
Introduction
Roax is a lightweight framework for building resource-oriented applications in Python. By composing your application as a set of resources that expose operations through a uniform interface, they can be automatically exposed through a REST and/or command line interface.
Features
- Resource operations accessed through WSGI based REST API.
- Command-line interface to resource operations.
- Generates OpenAPI interface description, compatible with Swagger UI.
- Schema enforcement of resource operation parameters and return values.
- Authorization to resource operations enforced through imperative security policies.
Quick start
Installation
pip install roax
Hello world
Here is a minimal application that responds with "Hello world!"
when the
client accesses http://localhost:8000/hello.
import roax.schema as schema
from roax.resource import Resource, operation
from roax.wsgi import App
from wsgiref.simple_server import make_server
class HelloResource(Resource):
@operation(returns=schema.str(), security=[])
def read(self):
return "Hello world!"
app = App("/", "Hello", "1.0")
app.register_resource("/hello", HelloResource())
if __name__== "__main__":
make_server("", 8000, app).serve_forever()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
roax-1.8.0.tar.gz
(34.0 kB
view hashes)
Built Distribution
roax-1.8.0-py3-none-any.whl
(38.6 kB
view hashes)