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

Uploaded Source

Built Distribution

mokei-0.2.8-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mokei-0.2.8.tar.gz
  • Upload date:
  • Size: 10.6 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.8.tar.gz
Algorithm Hash digest
SHA256 f0ae5098c23f739774f1505b2db9bbb2b6b6651c1219146ae934da9094794e08
MD5 7018a768681099b95dc6f50087a540d4
BLAKE2b-256 8977ded0a8b91a141ef90ef71e5977a75ce5707a1f2b6e3319823462802eb5a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mokei-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 14.1 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a55b115deacbc56ba9f2c0a407b9773722172bd0af0386b1a1d2037025efaec7
MD5 40dde27b70370e24d9d8cc912ecd6da7
BLAKE2b-256 0f3be4ea624519fa14e3f40a675413965bb88069f307e24636dd30664b1573d8

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