Skip to content

jaraco/http-okapi

Repository files navigation

tests Code style: Black

A simple HTTP API tool.

The Tool

The tool is an HTML page with a background image. These resources are presented as package resources of the http_okapi package. The resource filenames are okapi.html and okapibg.png. The HTML page references okapibg.png by name, so the two files are meant to be served from the same path.

CherryPy Handler

This package also presents a server implementation for CherryPy. To use it, simply bind the http_okapi.cherrypy.Server somewhere in your handler tree:

class MyServer:
    okapi = http_okapi.cherrypy.Server()

Then, the okapi tool will be available at that path.