Skip to main content

A simple asynchronous Python web framework built on aiohttp.

Project description

Mokei

Mokei is a simple asynchronous Python web framework built on aiohttp.

Aiohttp contains a great async web server, with web framework built in, but can be complex when compared to other web frameworks.

Mokei makes setting up your routes as simple as using Flask or FastAPI. It also includes super easy websocket routes with support for text and binary messages, as well as SocketIO-style event handlers.

Quick Start

from mokei import Mokei

app = Mokei()

@app.get('/')
async def hello():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run()

Return JSON data

When the return type from the handler is a dict, the response is automatically converted to application/json

@app.get('/status')
async def status():
    return {
        'status': 'OK',
    }

Adding Websocket support

Adding a websocket route is as simple as adding a normal get route.

Note that you may send websocket messages to a route or to a single websocket (compare websocket.send_text and data.send_text below)

app = Mokei()
data = app.websocketroute('/data')

@data.onconnect
async def send_welcome_text(websocket):
    await websocket.send_text('Welcome!')

@data.ontext
async def relay_text(websocket, text):
    # log incoming text and relay to all other websockets
    logger.info('Received text %s', text)
    await data.send_text(text, exclude=websocket)

SocketIO-style events are also supported. See js/mokei.js for a Javascript handler for Mokei WebSockets.

app = Mokei()
data = app.websocketroute('/data')

@data.on('ping')
async def send_pong(websocket, data):
    update_something(websocket)
    await websocket.send_event('pong', {'timestamp': time.time()})

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mokei-0.2.13.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

mokei-0.2.13-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file mokei-0.2.13.tar.gz.

File metadata

  • Download URL: mokei-0.2.13.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for mokei-0.2.13.tar.gz
Algorithm Hash digest
SHA256 5ee02c3059cc6c25d0470cecc0a6937f9b40ebd5d26990d80f7a39c2b28778eb
MD5 b3773443bc28c30537cfb8d10bf8f9bb
BLAKE2b-256 74a8d75386f1f12425002cf8576076e1f1a544adcedce5f42009581389cdbce8

See more details on using hashes here.

File details

Details for the file mokei-0.2.13-py3-none-any.whl.

File metadata

  • Download URL: mokei-0.2.13-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for mokei-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 c572ffa702c1e784c8d95199a93231af7ca7178377714e955b958db20741c656
MD5 cb67beda3baf4c092b010fc1a2a69f5b
BLAKE2b-256 88d98fa48264ba5b5d578a8989b55dc3b31bca8f06e6eaa54fd2f0896cccdcba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page