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

Uploaded Source

Built Distribution

mokei-0.2.17-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mokei-0.2.17.tar.gz
  • Upload date:
  • Size: 13.4 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.17.tar.gz
Algorithm Hash digest
SHA256 c078f39af561fccf3b16312e2d7845052b9cbec8d23207fc340b642f017015bb
MD5 47999888c0e8de8ae51d50f843bfa8b4
BLAKE2b-256 9e7c21d78436833b20d9f71ecece17649b52d2b1d920f2c261f4bdc21374e80c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mokei-0.2.17-py3-none-any.whl
  • Upload date:
  • Size: 18.1 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 337603d470e2bd1ed482c2be038e84490a16d9db8f23bf8017fcba76b637c9cd
MD5 39628fdccc750058399fa87a45c55c3b
BLAKE2b-256 a354c5cd6a81343572ff874325f56318485dc39c2ac42d6449a7745a6ba04551

See more details on using hashes here.

Supported by

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