Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhuntdev/blest-py
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 by default, and provides a modern alternative to REST.
https://github.com/jhuntdev/blest-py
api blest client django fastapi flask python server
Last synced: 1 day ago
JSON representation
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 by default, and provides a modern alternative to REST.
- Host: GitHub
- URL: https://github.com/jhuntdev/blest-py
- Owner: jhuntdev
- License: mit
- Created: 2023-06-11T21:06:58.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-28T08:46:04.000Z (20 days ago)
- Last Synced: 2024-10-28T16:10:34.252Z (20 days ago)
- Topics: api, blest, client, django, fastapi, flask, python, server
- Language: Python
- Homepage:
- Size: 37.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 by default, and provides a modern alternative to REST. It includes examples for Django, FastAPI, and Flask.
To learn more about BLEST, please visit the website: https://blest.jhunt.dev
For a front-end implementation in React, please visit https://github.com/jhuntdev/blest-react
## Features
- Built on JSON - Reduce parsing time and overhead
- Request Batching - Save bandwidth and reduce load times
- Compact Payloads - Save even more bandwidth
- Single Endpoint - Reduce complexity and facilitate introspection
- Fully Encrypted - Improve data privacy
## Installation
Install BLEST Python from PyPI.
```bash
python3 -m pip install blest
```
## Usage
### Router
The following example uses Flask, but you can find examples with other frameworks [here](examples).
```python
from flask import Flask, make_response, request
from blest import Router
# Instantiate the Router
router = Router({ 'timeout': 1000 })
# Create some middleware (optional)
@router.before_request
async def auth_middleware(body, context):
if context['headers']['auth'] == 'myToken':
context['user'] = {
# user info for example
}
return
else:
raise Exception('Unauthorized')
# Create a route controller
@router.route('greet')
async def greet_controller(body, context):
return {
'greeting': f"Hi, {body['name']}!"
}
# Instantiate a Flask application
app = Flask(__name__)
# Handle BLEST requests
@app.post('/')
async def index():
result, error = await router.handle(request.json, { 'headers': request.headers })
if error:
resp = make_response(error, error.status or 500)
resp.headers['Content-Type'] = 'application/json'
else:
resp = make_response(result, 200)
resp.headers['Content-Type'] = 'application/json'
return resp
```
### HttpClient
```python
from blest import HttpClient
async def main():
# Create a client
client = HttpClient('http://localhost:8080', {
'max_batch_size': 25,
'buffer_delay': 10,
'http_headers': {
'Authorization': 'Bearer token'
}
})
# Send a request
try:
result = await client.request('greet', { 'name': 'Steve' }, { 'auth': 'myToken' })
# Do something with the result
except Exception as error:
# Do something in case of error
```
## License
This project is licensed under the [MIT License](LICENSE).