Willpyre

Willpyre provides abstraction over ASGI. It supports HTTP without external dependencies. Websockets support is yet to come. [You can still use python-socketio].

Micro-framework

Willpyre is micro, but it does not mean it is not capable of doing. It means, it lets you choose anything and runs with anything.

The quick starts provides you with information about the components. It gives some basic examples as well. The documentation covers most of the basic parts of the code. Extending the components, startup and shutdown tasks, custom error responses, etc. are present in the “advanced” section.

Contents

• Installation
  • Willpyre Installation
  • ASGI server installation
  • Testing framework installation
• Quick Start
  • URL Routing
    • Embed a router
    • Variables in URL path
    • Validation
    • Multiple Vars
• Request object
• Response object
• Middlewares
• Advanced
  • Extending the Router
  • Custom error responses
  • Startup and Shutdown tasks
• Using SwaggerUI (by OpenAPI)
  • Step 0 (Define the Models):
  • Step 1 (Import an APIRouter):
  • Step 2 (Initialise the Router):
  • Step 3 (Register routes):
• Working with models (schemas)
  • Loading JSON from Schema
  • Validating JSON Against a Schema
• Documentation
  • Module contents
    • APIRouter
    • App
      • App.add_middleware()
    • HTMLResponse
    • JSONResponse
    • OpenAPIRouter
      • OpenAPIRouter.add_api_route()
      • OpenAPIRouter.add_route()
      • OpenAPIRouter.connect()
      • OpenAPIRouter.fetch()
      • OpenAPIRouter.get()
      • OpenAPIRouter.handle()
      • OpenAPIRouter.openapi()
      • OpenAPIRouter.options()
      • OpenAPIRouter.patch()
      • OpenAPIRouter.post()
      • OpenAPIRouter.put()
      • OpenAPIRouter.trace()
    • Redirect
    • Router
      • Router.add_route()
      • Router.add_ws_route()
      • Router.embed_router()
      • Router.handle()
      • Router.handleWS()
    • TextResponse
    • willpyre.router
      • OpenAPIRouter
        • OpenAPIRouter.add_api_route()
        • OpenAPIRouter.add_route()
        • OpenAPIRouter.connect()
        • OpenAPIRouter.fetch()
        • OpenAPIRouter.get()
        • OpenAPIRouter.handle()
        • OpenAPIRouter.openapi()
        • OpenAPIRouter.options()
        • OpenAPIRouter.patch()
        • OpenAPIRouter.post()
        • OpenAPIRouter.put()
        • OpenAPIRouter.trace()
      • Router
        • Router.add_route()
        • Router.add_ws_route()
        • Router.embed_router()
        • Router.handle()
        • Router.handleWS()
      • StaticRouter
        • StaticRouter.add_endpoint()
        • StaticRouter.add_method()
        • StaticRouter.add_route()
        • StaticRouter.connect()
        • StaticRouter.endpoint_for()
        • StaticRouter.fetch()
        • StaticRouter.get()
        • StaticRouter.handle()
        • StaticRouter.options()
        • StaticRouter.patch()
        • StaticRouter.post()
        • StaticRouter.put()
        • StaticRouter.trace()
    • willpyre.structure
      • Cookie
        • Cookie.cookie_str
        • Cookie.http_only
        • Cookie.max_age
        • Cookie.same_site
        • Cookie.secure
        • Cookie.value
      • FileObject
        • FileObject.content
        • FileObject.filename
        • FileObject.name
      • HTMLResponse
      • HTTPException
      • JSONResponse
      • Redirect
      • Request
        • Request.cookies
        • Request.params
      • Response
      • Response404
      • Response404JSON
      • Response405
      • Response405JSON
      • Response422JSON
      • Response500
      • Response500JSON
      • TextResponse
      • TypedMultiMap
        • TypedMultiMap.add()
        • TypedMultiMap.get()
        • TypedMultiMap.get_all()
        • TypedMultiMap.items()
        • TypedMultiMap.to_dict()
      • parse_multipart()
    • willpyre.app
      • App
        • App.add_middleware()