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
Metadata
1 maintainer
Release files for chisel 2.4.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| chisel-2.4.14.tar.gz | 271.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| chisel-2.4.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 543.5 kB
Release files / chisel-2.4.14.tar.gz
| Download URL | chisel-2.4.14.tar.gz |
|---|---|
| Size | 271.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d984c40abdd85cac4ee8c28f3be9abbf74218c871eb2f327b4c077f24ba28edc
|
|
BLAKE2b-256 checksum How to use checksums |
d898307a49a3a8d12d76721016024b7a5e245b2626414231d4b7ec55be49b099
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / chisel-2.4.14-py3-none-any.whl
| Download URL | chisel-2.4.14-py3-none-any.whl |
|---|---|
| Size | 271.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fdf7c32eb27ab85972384641f60f6aebd579490c96cf8056921f01d6f48761b3
|
|
BLAKE2b-256 checksum How to use checksums |
0e9de6c49afc55928d249cf1a48818afc5e2b30f4da492a08ea11add8291bece
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for chisel 2.4.14
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
