chisel
Chisel is a lightweight Python WSGI application framework built for creating well-documented, schema-validated JSON web APIs.
Links
JSON APIs
Chisel provides the action decorator for easily implementing schema-validated JSON APIs.
import chisel
@chisel.action(spec='''
# Sum a list of numbers
action sum_numbers
urls
GET
query
# The list of numbers
float[len > 0] numbers
output
# The sum of the numbers
float sum
''')
def sum_numbers(ctx, req):
return {'sum': sum(req['numbers'])}
application = chisel.Application()
application.add_request(sum_numbers)
application.request('GET', '/sum_numbers', query_string='numbers.0=1&numbers.1=2&numbers.2=4')
('200 OK', [('Content-Type', 'application/json')], b'{"sum":7.0}')
Each action defines an action definition using
Schema Markdown.
The action callback is passed two arguments, a request
Context
and the schema-validated request input dictionary. The input request dictionary is created by
combining the request's URL path parameters, query string parameters, and input JSON content
parameters.
If there is a schema validation error the appropriate error code is automatically returned.
status, _, content_bytes = application.request('GET', '/sum_numbers')
'400 Bad Request'
b'{"error":"InvalidInput","message":"Required member \\"numbers\\" missing (query string)"}'
A chisel.Application is a standard WSGI application object - host it with any WSGI server. For example:
gunicorn module:application
API Documentation
You can add API documentation to your application by adding the Chisel documentation application requests from create_doc_requests.
application = chisel.Application()
application.add_requests(chisel.create_doc_requests())
By default the documentation application is hosted at "/doc/". An example of Chisel's documentation output is available.
Development
This package is developed using python-build. It was started using python-template as follows:
template-specialize python-template/template/ chisel/ -k package chisel -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k nomain 1
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chisel-2.4.2.tar.gz.
File metadata
- Download URL: chisel-2.4.2.tar.gz
- Upload date:
- Size: 212.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee1db25be9e774983f4ce321f1a62316ea3f0985de43da00a8330f25c5cf0509
|
|
| MD5 |
f1e54d1118fafef1e7e8f67f5fd7c891
|
|
| BLAKE2b-256 |
644139e3a7ad008addfb48045a3e154d1243f0c9d5afa13b49545810d14ec864
|
File details
Details for the file chisel-2.4.2-py3-none-any.whl.
File metadata
- Download URL: chisel-2.4.2-py3-none-any.whl
- Upload date:
- Size: 212.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f0d42e22792c5f54bacf5987e1142babbc8b6bcc73971f3f9e55f0abd498285
|
|
| MD5 |
42655f8cfe6ae03ff674dd59f19e0448
|
|
| BLAKE2b-256 |
ac219e4b38e79348c8fa58df2af27fa68dec8245faf4750755cb3be7a5b2ba65
|
