bagrat / calm Goto Github PK

The users should be able to define custom Tornado RequestHandlers and add them to the Calm application.

• Add decorators to describe the API
• Add API definition autogeneration

https://github.com/cygwin/calm

The documenttion is handled by MkDocs and should go into docs directory.

When a URL is not found the Tornado 404 response is returned to the client, which happens to be HTML.

Make a custom JSON 404 response by configuring Tornado's default_handler application setting.

PyPI does not support Markdown as the long_description format, thus we cannot use README.md for it.

Write up a brief description of Calm including all references for more information.

MIght be helpful to use Binder.

Hi
Firstly, thank you for releasing Calm - I am having fun working with it.

I found that I needed to set a default header on all requests to enable CORS. I ended up using the following hack:

import calm.core
def set_default_headers(self, args, **kwargs):
self.set_header("Access-Control-Allow-Origin", "")

calm.core.MainHandler.set_default_headers = set_default_headers

May be this is not the correct way to achieve this, but it would be great if there was a documented way to add a default header with out having to use custom request handler classes.

Many thanks

Richard

Enable defining several version of the API in the same codebase.

Add a means to be able to define Calm Application security layer:

• Add decorators and classes to define the security logic
• Add security definitions to swagger.json