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.18.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mokei-0.2.18-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mokei-0.2.18.tar.gz
Algorithm Hash digest
SHA256 f486314f9619f37f338cc46a80246a12a78f38cba5affa90101a9984d050016a
MD5 5fac04ed9ac688914023bbf73c6b3a11
BLAKE2b-256 17a08da3ae307b78250e292b37e2f8162a42e1a80f6cadc5898e987799eb56af

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mokei-0.2.18-py3-none-any.whl
Algorithm Hash digest
SHA256 d5193acb21f6dfa58112d4daf5bd5686cc08b2dca5dfd454eb0bff59b2740d1c
MD5 05612cbd6cb2ccf03c5e158ea1a70112
BLAKE2b-256 85421b3d82aef4ef8eb1c426611ed035f3403a31a93bca727013f1fcefc9f68c

See more details on using hashes here.

Supported by

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