Skip to main content

The Python reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer)

Project description

BLEST Python

The Python reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching and selective returns, and provides a modern alternative to REST. It includes examples for Django, FastAPI, and Flask.

To learn more about BLEST, please refer to the white paper: https://jhunt.dev/BLEST%20White%20Paper.pdf

Features

  • Built on JSON - Reduce parsing time and overhead
  • Request Batching - Save bandwidth and reduce load times
  • Compact Payloads - Save more bandwidth
  • Selective Returns - Save even more bandwidth
  • Single Endpoint - Reduce complexity and improve data privacy
  • Fully Encrypted - Improve data privacy

Installation

Install BLEST Python from PyPI.

pip install blest

Usage

Server-side

Use the create_server function to create a standalone HTTP server, or use the create_request_handler function to create a request handler suitable for use in an existing Python application. Both functions allow you to define middleware in your router.

create_server

from blest import create_server

# Create some middleware (optional)
def auth_middleware(params, context):
  if params.name:
    context.user = {
      'name': params.name
    }
  else:
    raise Exception('Unauthorized')

# Create a route controller
def greet_controller(params, context):
  return {
    'greeting': f'Hi, {context.user.name}!'
  }

# Define your router
router = {
  'greet': [auth_middleware, greet_controller]
}

run = create_server(router)

if __name__ == '__main__':
  run()

create_request_handler

The following example uses Flask, but you can find examples with other frameworks here.

from flask import Flask, make_response, request
from blest import create_request_handler

async def greet(params, context):
  return {
    'geeting': 'Hi, ' + params.get('name') + '!'
  }

routes = {
  'greet': greet
}

router = create_request_handler(routes)

app = Flask(__name__)

@app.post('/')
async def index():
  result, error = await router(request.json)
  if error:
    resp = make_response(error, 500)
    resp.headers['Content-Type'] = 'application/json'
  else:
    resp = make_response(result, 200)
    resp.headers['Content-Type'] = 'application/json'
    return resp

Client-side

Client-side libraries assist in batching and processing requests and commands. Currently available for React with other frameworks coming soon.

React

import React from 'react'
import { useBlestRequest, useBlestCommand } from 'blest-react'

// Use the useBlestRequest hook for fetching data
const MyComponent = () => {
  const { data, loading, error } = useBlestRequest('listItems', { limit: 24 })

  return (
    // Render your component
  )
}

// Use the useBlestCommand hook for sending data
const MyForm = () => {
  const [submitMyForm, { data, loading, error }] = useBlestCommand('submitForm')
  
  const handleSubmit = (values) => {
    return submitMyForm(values)
  }

  return (
    // Render your form
  )
}

Contributing

We actively welcome pull requests. Learn how to contribute for more information.

License

This project is licensed under the MIT License.

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

BLEST-0.0.4.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

BLEST-0.0.4-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file BLEST-0.0.4.tar.gz.

File metadata

  • Download URL: BLEST-0.0.4.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for BLEST-0.0.4.tar.gz
Algorithm Hash digest
SHA256 ddca8f7222c88958904ea62d8694fafcbc563d13c5ff70b68c796a89113b098c
MD5 675d4248b412592cf383bea658267192
BLAKE2b-256 1eaab69acdbf48d438b5212cf9bed7ad7baca4587ce1826337be0396f055c63e

See more details on using hashes here.

File details

Details for the file BLEST-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: BLEST-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for BLEST-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ef9c6ebc48b931f3709b6fbb775968074878b642a40edcd51ff423e2f4a65dbc
MD5 ffab973d670cdb04b522241a3cd09a98
BLAKE2b-256 8876e1ac75814c384e169073330ee35f82b32ddba8b0ef7f3ef2fd1af3240fe6

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