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

Uploaded Source

Built Distribution

mokei-0.2.4-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mokei-0.2.4.tar.gz
  • Upload date:
  • Size: 10.3 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.4.tar.gz
Algorithm Hash digest
SHA256 403e23901078653fcb9d2ee688fef2f1795ea79f8d7e48b977f2f5bf67e9d522
MD5 6192ade866f84adc38fbce70abe10017
BLAKE2b-256 7234fdde2043a213dad885b946b439c2a4fcdaaefe8bff1ca858b73ed6678348

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mokei-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 13.8 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7afd0b8fa49df3b1a72deb7aceb022723c2bee0dfba640e67292284e70de4714
MD5 eaea2403f80c433418b354124524eac6
BLAKE2b-256 6978b2942f0f78fa7c64fb0b520ba85c82d9e3d7c9079976aac77a9333a03d3c

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